Installation & Setup

Follow these instructions to set up both the web and CLI versions of Coach.

Frontend (Next.js)

You can access the web-based interface of Coach here.

If you want to run Coach locally,

The frontend is built with Next.js 14 and can be set up as follows:

bash

# Clone the repository
git clone https://github.com/annick975/Coach
cd Coach

# Install dependencies
npm install

# Set up environment variables
cp .env.example .env.local
# Edit .env.local with your API keys and configuration

# Run development server
npm run dev

Backend (FastAPI, Python)

The backend requires Python 3.9+ and can be set up as follows:

bash

# Navigate to the backend directory
cd Coach/backend

# Create a virtual environment
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install dependencies
pip install -r requirements.txt

# Set up environment variables
cp .env.example .env
# Edit .env with your API keys and configuration

# Run the development server
uvicorn app.main:app --reload

CLI Version

The CLI version can be installed and used independently:

bash

# Install the CLI tool -> Clone the repository:
git clone https://github.com/Rukundo-Bahati/Coach.git
cd Coach/coach

# Create a virtual environment:
python3 -m venv venv_new
source venv_new/bin/activate

# Install Python dependencies:
pip3 install .
(Note: Ensure requirements.txt includes rich, pyfiglet, gitpython, requests, etc.)

# Check and install reqired tools:
python3 coach

# Analyze a repository by providing its URL and branch:
coach https://github.com/username/repo.git main

Environment Variables

Make sure to set these required environment variables:

Variable	Description
GEMINI_API_KEY	Your Gemini API key for AI-powered fixes
GITHUB_TOKEN	GitHub personal access token with repo permissions
DATABASE_URL	Connection string for your database