Development Setup

# Install uv
curl -LsSf https://astral.sh/uv/install.sh | sh
 
# Verify installation
uv --version

# Install nvm
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash
 
# Restart your terminal or run
source ~/.bashrc
 
# Install Node.js 18
nvm install 18
nvm use 18
 
# Verify installation
node --version
npm --version

# macOS (using Homebrew)
brew install postgresql
brew services start postgresql
 
# Ubuntu/Debian
sudo apt update
sudo apt install postgresql postgresql-contrib
sudo systemctl start postgresql
 
# Create database
createdb rhesis_dev

# macOS (using Homebrew)
brew install redis
brew services start redis
 
# Ubuntu/Debian
sudo apt install redis-server
sudo systemctl start redis-server

# Fork the repository on GitHub first, then clone your fork
git clone https://github.com/YOUR_USERNAME/rhesis.git
cd rhesis
 
# Add the upstream repository
git remote add upstream https://github.com/rhesis-ai/rhesis.git

# Install Python dependencies
uv sync
 
# Install frontend dependencies
cd apps/frontend
npm install
 
# Install documentation dependencies
cd ../docs
npm install
 
# Return to root
cd ../..

# Copy the example environment file
cp .env.example .env
 
# Edit the environment file with your configuration
# You'll need to set up database URLs, API keys, etc.

# Database Configuration
DATABASE_URL=postgresql://username:password@localhost/rhesis_dev
TEST_DATABASE_URL=postgresql://username:password@localhost/rhesis_test
 
# Redis Configuration
REDIS_URL=redis://localhost:6379
 
# Authentication
SECRET_KEY=your-secret-key-here
JWT_ALGORITHM=HS256
JWT_ACCESS_TOKEN_EXPIRE_MINUTES=30
 
# External Services
OPENAI_API_KEY=your-openai-api-key
GITHUB_CLIENT_ID=your-github-client-id
GITHUB_CLIENT_SECRET=your-github-client-secret
 
# Development Settings
DEBUG=true
ENVIRONMENT=development

# Navigate to backend directory
cd apps/backend
 
# Run database migrations
uv run alembic upgrade head
 
# Create initial data (if needed)
uv run python -m rhesis.backend.scripts.create_initial_data
 
# Return to root
cd ../..

# Start all services
./rh backend start
./rh frontend start
./rh docs start
 
# Or start them all at once (if configured)
./rh start all

# Backend (FastAPI)
cd apps/backend
uv run uvicorn rhesis.backend.app.main:app --reload --port 8080
 
# Frontend (Next.js)
cd apps/frontend
npm run dev
 
# Documentation (Nextra)
cd apps/documentation
npm run dev
 
# Worker (Celery)
cd apps/worker
uv run celery -A rhesis.worker worker --loglevel=info

# Test backend health
curl http://localhost:8080/health
 
# Test database connection
cd apps/backend
uv run python -c "from rhesis.backend.database import get_db; print('Database OK')"
 
# Test Redis connection
uv run python -c "import redis; r = redis.Redis(); print('Redis OK')"

# Install pre-commit hooks
uvx pre-commit install
 
# Run pre-commit on all files
uvx pre-commit run --all-files

{
  "python.defaultInterpreter": "./.venv/bin/python",
  "python.formatting.provider": "ruff",
  "editor.formatOnSave": true,
  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": true
  }
}

# Backend tests
cd apps/backend
uv run pytest
 
# Frontend tests
cd ../frontend
npm test
 
# All tests from root
uv run pytest tests/

# apps/backend/tests/test_example.py
def test_health_endpoint(client):
    """Test the health check endpoint."""
    response = client.get("/health")
    assert response.status_code == 200
    assert response.json()["status"] == "healthy"

# Check if PostgreSQL is running
sudo systemctl status postgresql
 
# Check if Redis is running
sudo systemctl status redis-server
 
# Test database connection
psql -h localhost -U your_username -d rhesis_dev

# Recreate virtual environment
rm -rf .venv
uv sync
 
# Check Python version
python --version

# Clear npm cache
npm cache clean --force
 
# Reinstall dependencies
rm -rf node_modules package-lock.json
npm install