LICENSE and README.md files
This commit is contained in:
Eng. Elias
9
LICENSE
Normal file
9
LICENSE
Normal file
@@ -0,0 +1,9 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2024 Eng. Elias
|
||||
|
||||
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.
|
||||
112
README.md
112
README.md
@@ -1,36 +1,110 @@
|
||||
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
|
||||
# CrewAI Simplified App
|
||||
|
||||
This application provides a simplified user interface for leveraging the power of CrewAI, a cutting-edge framework for orchestrating role-playing autonomous AI agents. With this app, users can streamline the process of creating and managing AI crews without the need for coding.
|
||||
|
||||
## Features
|
||||
|
||||
- **Intuitive UI**: The app offers a user-friendly interface, allowing users to easily create and manage AI crews.
|
||||
- **Role-Based Agent Design**: Customize agents with specific roles, goals, and tools through a simple form-based approach.
|
||||
- **Task Management**: Define tasks and assign them to agents dynamically.
|
||||
- **Sequential and Hierarchical Processes**: Choose between sequential or hierarchical processes for task execution, depending on your workflow needs.
|
||||
- **Save Output**: Save the output for future reference or analysis.
|
||||
- **Connection to LLM model**: for this version I used Gemini model and I plan to add more models in the future.
|
||||
|
||||
## Getting Started
|
||||
|
||||
First, run the development server:
|
||||
To get started with the CrewAI Simplified App, follow these simple steps:
|
||||
|
||||
1. **Installation**: Clone the repository and install dependencies using npm or yarn:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/Eng-Elias/CrewAI-Visualizer.git
|
||||
cd crewai-simplified-app
|
||||
npm install
|
||||
```
|
||||
|
||||
2. **Create Python Virtual Enviroment**: create Python venv, activate the venv and install the requirements.
|
||||
|
||||
Create venv:
|
||||
|
||||
```bash
|
||||
python -m venv venv
|
||||
```
|
||||
|
||||
To activate the virtual environment on Windows:
|
||||
|
||||
```bash
|
||||
.\venv\Scripts\activate
|
||||
```
|
||||
|
||||
To activate the virtual environment on Linux or Mac:
|
||||
|
||||
```bash
|
||||
source venv/bin/activate
|
||||
```
|
||||
|
||||
Install the requirements:
|
||||
|
||||
```bash
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
3. **Configuration**: Set up your environment variables in a `.env` file:
|
||||
|
||||
Just rename .env.template to .env and set your values:
|
||||
|
||||
```plaintext
|
||||
DATABASE_URL="postgresql://postgres:postgres@localhost:5432/ crew_ai_visualizer?schema=public"
|
||||
|
||||
GEMINI_API_KEY=""
|
||||
|
||||
PYTHON_SITE_PACKAGES="<The path of site packages folder in the venv you created in the previous step>"
|
||||
|
||||
CREW_AI_PY_FILE="<the path of my crew_ai.py file in on your system. you can find it in src/app/api/graphql/crew_ai.py>"
|
||||
```
|
||||
|
||||
4. **Start the Development Server**: Run the following command to start the development server:
|
||||
|
||||
```bash
|
||||
npm run dev
|
||||
# or
|
||||
yarn dev
|
||||
# or
|
||||
pnpm dev
|
||||
# or
|
||||
bun dev
|
||||
```
|
||||
|
||||
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
|
||||
5. **Access the App**: Once the development server is running, access the app in your browser at `http://localhost:3000`.
|
||||
|
||||
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
|
||||
## Usage
|
||||
|
||||
This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
|
||||
1. **Create a New Crew**: By adding agents.
|
||||
|
||||
## Learn More
|
||||
2. **Customize Agents**: Fill in the information for each agent, including role, goal, backstory, tools, allow_deligation, and verbose.
|
||||
|
||||
To learn more about Next.js, take a look at the following resources:
|
||||
3. **Define Missions**: Fill mission information including name, crew, verbose, process and add tasks with their details (name, description, agent).
|
||||
|
||||
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
|
||||
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
|
||||
4. **Execute Mission**: Once your mission is set up, execute it to start the execution process.
|
||||
|
||||
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
|
||||
5. **View Results**: View the output of completed missions within the app.
|
||||
|
||||
## Deploy on Vercel
|
||||
## Contributing
|
||||
|
||||
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
|
||||
We welcome contributions to the CrewAI Simplified App. If you'd like to contribute, please follow these steps:
|
||||
|
||||
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
|
||||
1. Fork the repository.
|
||||
2. Create a new branch for your feature or improvement.
|
||||
3. Add your feature or improvement.
|
||||
4. Submit a pull request.
|
||||
|
||||
## Tech Stack
|
||||
|
||||
This app is built using TypeScript, Prisma, GraphQL, Next.js, and node-calls-python to execute Python code from Node.js and get the result in addition to use Gemini as LLM.
|
||||
|
||||
## License
|
||||
|
||||
This application is open-source and is released under the MIT License. See the [LICENSE](LICENSE) file for details.
|
||||
|
||||
## To Do
|
||||
|
||||
- [ ] Add more tools for agents either from LangChain community or create new useful tools.
|
||||
- [ ] Add more LLM options like ChatGPT and local LLMs.
|
||||
|
||||
## Credits
|
||||
|
||||
Special thanks to [João Moura](https://github.com/joaomdmoura) the creator of [CrewAI](https://github.com/joaomdmoura/crewAI) for providing the underlying framework for AI crew orchestration.
|
||||
|
||||
Reference in New Issue
Block a user