https://github.com/sachs7/explainit

A basic CrewAI app that tries to explain things in simple terms
https://github.com/sachs7/explainit

ai basic crewai crewai-tools llama3 llm streamlit streamlit-webapp

Last synced: 19 days ago
JSON representation

A basic CrewAI app that tries to explain things in simple terms

• Host: GitHub
• URL: https://github.com/sachs7/explainit
• Owner: sachs7
• License: mit
• Created: 2024-11-21T23:50:22.000Z (about 1 month ago)
• Default Branch: main
• Last Pushed: 2024-11-22T02:42:26.000Z (about 1 month ago)
• Last Synced: 2024-12-03T16:53:48.649Z (19 days ago)
• Topics: ai, basic, crewai, crewai-tools, llama3, llm, streamlit, streamlit-webapp
• Language: Python
• Homepage:
• Size: 213 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Explainit Crew

Welcome to the Explainit Crew project, powered by [crewAI](https://crewai.com). A basic CrewAI app that tries to explain given topics in simple terms.

## Installation

Ensure you have Python >=3.10 <=3.13 installed on your system. This project uses [UV](https://docs.astral.sh/uv/) for dependency management and package handling, offering a seamless setup and execution experience.

ExplainIt uses Llama3.2, you can find the installation instructions [here](https://docs.crewai.com/how-to/llm-connections#using-local-models-with-ollama). Feel free to explore other LLMs based on the [CrewAI documentation](https://docs.crewai.com/how-to/llm-connections#connect-crewai-to-llms) and speed up the inference.

First, if you haven't already, install uv:

```bash

pip install uv

```

Next, navigate to your project directory and install the dependencies:

(Optional) Lock the dependencies and install them by using the CLI command:

```bash

crewai install

```

### Customizing

**Add your `Llama` details into the `.env` file**

- Modify `src/explainit/config/agents.yaml` to define your agents

- Modify `src/explainit/config/tasks.yaml` to define your tasks

- Modify `src/explainit/crew.py` to add your own logic, tools and specific args

- Modify `src/explainit/main.py` to add custom inputs for your agents and tasks

## Running the Project

To kickstart your crew of AI agents and begin task execution, run this from the root folder of your project:

```bash

$ crewai run

```

This command initializes the explainIt Crew, assembling the agents and assigning them tasks as defined in your configuration.

This example, unmodified, will run the create a `report.md` file with the output of a research on LLMs in the root folder.

# Streamlit App

Instead of dealing with the CLI, if you want to interact with the app via browser, then, go to `src/explainit/main.py`:

1. comment the existing code block

2. install "streamlit" using: `uv pip install streamlit`

3. enable the code block containing streamlit block

4. run `streamlit run main.py`

5. access the app at: http://localhost:8501

## Result