docs: add license and readme

This commit is contained in:
Marcus Schiesser
2024-09-13 17:22:51 +07:00
parent 0d4b7f41d3
commit 8eb2004393
2 changed files with 64 additions and 0 deletions
+21
View File
@@ -0,0 +1,21 @@
The MIT License
Copyright (c) LlamaIndex
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.
+43
View File
@@ -0,0 +1,43 @@
# App Creator
This project uses a multi-agent pattern with different OpenAI models (including the new [o1 models](https://platform.openai.com/docs/guides/reasoning)) to generate code for various applications based on provided specifications.
The multi-agents are implemented using [Workflows](https://ts.llamaindex.ai/modules/workflows) from [LlamaIndex](https://www.llamaindex.ai/).
## Getting Started
1. Clone the repository:
```
git clone https://github.com/run-llama/app-creator.git
cd app-creator
```
2. Install dependencies:
```
pnpm install
```
3. Run the project:
```
pnpm start
```
This will generate code for the specified applications and models (see the `apps` constant in `main.ts`). The generated code will be saved in the `output` directory.
## Project Structure
- `main.ts`: Main script that runs the code generation process
- `agent.ts`: Contains the AI agent implementation
- `output/`: Directory where generated code is saved to
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
## Learn More
To learn more about LlamaIndex, take a look at the following resources:
- [LlamaIndexTS Documentation](https://ts.llamaindex.ai) - learn about LlamaIndex (Typescript).
You can check out [the LlamaIndexTS GitHub repository](https://github.com/run-llama/LlamaIndexTS) - your feedback and contributions are welcome!