added LICENSE, contributing.md, and roadmap

Nutlope · Nutlope · commit d60846c9d775 · 2024-11-06T22:27:26.000-05:00
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,34 @@
+# Contributing Guide
+
+Thank you for your interest in contributing to this project! We accept contributions via bug reports, feature requests and pull requests. We also have a roadmap outlined below.
+
+For simple fixes or small items on the roadmap below, feel free to submit a pull request. For anything more complex, please open an issue first to discuss the changes you want to make.
+
+## Running the repo
+
+To run the repo locally, simply `npm install` to install dependencies and then `npm run dev` to run the app.
+
+## Roadmap
+
+- [ ] Add evals with Braintrust
+- [ ] Experiment with a prompt rewriter and launch this as well
+- [ ] Add dynamic OG images to the specific generations & include the prompt
+- [ ] Add a bunch of good examples, and have an LLM call automatically choose which ones to include in the system prompt
+- [ ] Look into bolt.new and if I should be using the Stackblitz UI instead
+- [ ] New redesign
+  - [ ] Encourage best practices by making the input and textarea & having pills to generate apps w/ good prompts
+- [ ] Add more customizability in terms of changing the prompt, temperature, ect...
+- [ ] Save previous versions so people can go back and forth between the generated ones
+- [ ] Could be nice to show a "featured apps" route on the site on /featured. Have a /id/${prompt} dynamic route that can display a bunch of nice example apps in the sandbox ready to go
+- [ ] Support more languages starting with Python (like streamlit), check out E2B
+- [ ] Try finetuning a smaller model on good prompts from 405b or o1/Claude
+- [ ] Add dark mode to the site overall, nice design change
+- [ ] Add self-correcting to the app so it can fix its own errors
+- [ ] Compressing prompt: Use small model like llama 3.1 70B to retain what happened in the past, good memory management is key
+- [ ] New route for updateCode that only sends the latest generated code + the modify request
+- [ ] Fix bug where if a user edits the code, then does a change, it doesn't use the edited code
+- [ ] Apply code diffs directly instead of asking the model to generate the code from scratch
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the project's license.
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Hassan El Mghari
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -22,29 +22,6 @@
 2. Create a `.env` file and add your [Together AI API key](https://dub.sh/together-ai/?utm_source=example-app&utm_medium=llamacoder&utm_campaign=llamacoder-app-signup): `TOGETHER_API_KEY=`
 3. Run `npm install` and `npm run dev` to install dependencies and run locally
 
-## Future Tasks
+## Contributing
 
-- [ ] Add evals with Braintrust
-- [ ] Experiment with a prompt rewriter and launch this as well
-- [ ] Make the toast that opens better like a modal for sharability
-- [ ] Add sharability to people can take their apps and share them publicly
-- [ ] Add the ability to toggle on and off shadcn components and others
-- [ ] Launch support for different themes &ndash; somehow pass down variables to components
-- [ ] Add dynamic OG images to the specific generations & include the prompt
-- [ ] Add more dynamic OG images for playwright
-- [ ] Address issue of ability to publish the same app repeatedly
-- [ ] Try chain of thought reasoning to see if it works better overall
-- [ ] Encourage best practices by making the input and textarea & having pills to generate apps w/ good prompts
-- [ ] Add more customizability in terms of changing the prompt, temperature, ect...
-- [ ] Save previous versions so people can go back and forth between the generated ones
-- [ ] Could be nice to show a "featured apps" route on the site on /featured. Have a /id/${prompt} dynamic route that can display a bunch of nice example apps in the sandbox ready to go
-- [ ] Support more languages starting with Python, check out E2B
-- [ ] Try chain of thought reasoning to see if it works better overall
-- [ ] Try finetuning a smaller model on good prompts from 405b or GPT-4/Claude
-- [ ] Add dark mode to the site overall, nice design change
-- [ ] Surface errors better in codesandbox to the user so people know what is wrong
-- [ ] Think about how to have 405B correct itself (sometimes it makes up imports)
-- [ ] New route for updateCode that only sends the latest generated code + the modify request
-- [ ] Fix bug where if a user edits the code, then does a change, it doesn't use the edited code
-- [ ] Apply code diffs directly instead of asking the model to generate the code from scratch
-- [ ] Add the ability to upload things like a screenshot for it to start from that
+For contributing to the repo, please see the [contributing guide](./CONTRIBUTING.md).
