CodeRed-Proj

How to Contribute

With Nix

1. Install Nix:

• Linux: Check your distro's package manager or follow the instructions here.
• MacOS: Follow the instructions here.
• Windows: First, set up WSL if you haven't already. Then, check your distro's package manager or follow the instructions here within your WSL environment.

2. Clone this repo:

git clone https://github.com/moadesiyun/CodeRed-Proj.git

3. Enter the development shell:

cd CodeRed-Proj
nix develop

4. Create an environment variable named GOOGLE_API_KEY containing your Google API key.

export GOOGLE_API_KEY=<your api key> # you will probably need to do this every time you reopen your terminal

Without Nix

1. Clone this repo:

git clone https://github.com/moadesiyun/CodeRed-Proj.git

2. Create and activate virtual environment:

cd CodeRed-Proj
python -m venv .venv
source .venv/bin/activate

3. Install dependencies:

pip install -r requirements.txt

4. Create an environment variable named GOOGLE_API_KEY containing your Google API key.

export GOOGLE_API_KEY=<your api key> # you will probably need to do this every time you reopen your terminal

Testing

• Everything:

python main.py

• Gemini:

python web/generator.py