README.md

Contributing to HADES

If you want to develop and/or contribute to HADES, follow the instructions below in the order they are listed (again, these instructions assume you already have git, make, and docker installed as well as a valid OpenAI API key).

• Setting up the rabbitmq Microservice
• Setting Up a Local Development Environment to Contribute to the backend Microservice
• Setting Up a Local Development Environment to Contribute to the frontend Microservice

Setting Up the rabbitmq Microservice

Open a terminal window and enter the commands below.

make DOCKER_COMPOSE_PROFILE=rabbitmq start

Setting Up a Local Development Environment to Contribute to the backend Microservice

Open a new terminal window, replace the sk-... string in the command below with a valid OpenAI API key, and then, paste the command in your second terminal window (not the one running the rabbitmq container).

export OPENAI_API_KEY="sk-..."

In the same terminal window, enter the commands below (from the root of the project directory).

cd backend
python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt 
export RABBITMQ_ADDRESS="localhost"
export RABBITMQ_PASSWORD="hades"
export RABBITMQ_PORT=5672
export RABBITMQ_REPORT_EXCHANGE_NAME="hades.injects.reports"
export RABBITMQ_USERNAME="hades"
uvicorn hades.main:api --host 0.0.0.0 --port 8888

Setting Up a Local Development Environment to Contribute to the frontend Microservice

Open a new terminal window and enter the commands below (again, from the root of the project directory).

cd frontend/hades
npm install
npm run dev