Create a copy of the reference env file in the root of the project and update the values accordingly.
cp .env.sample .env
Make sure you have pre-commit installed docs.
Then run the following command to set up the project's git hook scripts
pre-commit install
To run against all files you can use the following command
pre-commit run --all-files
Here's the steps to set up the project locally:
poetry shell
poetry install
make up
make setup
- Go to http://localhost:8000/admin in internet browser and login (admin/admin)
- Select "Variables" option in the menu on the left and fill in the "OPENAI_API_KEY" key value with your OpenAI API Key and click "Save"
- Click the "Add" button of the "Project" option in the menu on the left and fill in the "Name" and select the "Project directory" and click "Save" in red boxes in image bellow:
- Reopen in container / Open folder in container
poetry shell
make up
make setup
make up
make migrate
make loadfixtures
make createuser
- Go to http://localhost:8000/admin in internet browser and login (admin/admin)
- Select "Variables" option in the menu on the left and fill in the "OPENAI_API_KEY" key value with your OpenAI API Key and click "Save"
make up
make createuser
make ollama model=nomic-embed-text:latest
make ollama model=llama3.2:latest
- Go to http://localhost:8000/admin in internet browser and login (admin/admin)
- Select "Models" option in the menu on the left
- Fill in the models name and check the "active" checkbox in red boxes in the image bellow and click "Save" (pay attention to the LLM and Embeddings model name placement):
make up
make createuser
make ollama model=nomic-embed-text:latest
make ollama model=starcoder2:15b-instruct
- Go to http://localhost:8000/admin in internet browser and login (admin/admin)
- Select "Models" option in the menu on the left
- Fill in the models name and check the "active" checkbox in red boxes in the image bellow and click "Save" (pay attention to the LLM and Embeddings model name placement):
make up
make createuser
make ollama model=nomic-embed-text:latest
make ollama model=qwen2.5:7b-instruct
- Go to http://localhost:8000/admin in internet browser and login (admin/admin)
- Select "Models" option in the menu on the left
- Fill in the models name and check the "active" checkbox in red boxes in the image bellow and click "Save" (pay attention to the LLM and Embeddings model name placement):
make up
make createuser
make ollama model=nomic-embed-text:latest
make ollama model=deepseek-r1
|deepseek-coder
|deepseek-coder-v2
, coder-v2 is the best if you have a good machine.- Go to http://localhost:8000/admin in internet browser and login (admin/admin)
- Select "Models" option in the menu on the left
- Fill in the models name and check the "active" checkbox in red boxes in the image below and click "Save" (pay attention to the LLM and Embeddings model name placement):
There are some prompt examples in here. These are sorted by complexity and are a way for us to measure the quality of the LLM's response.