AI-powered README documentation generator
- Python 3.11+
- Node.js 20+
- Docker Desktop
- pnpm
git clone https://github.com/olael94/docrelief-ai.git
cd docrelief-aidocker-compose up postgresKeep this terminal running!
Open a new terminal:
cd backend
# Create virtual environment
python3 -m venv venv
# Activate virtual environment
# Mac/Linux:
source venv/bin/activate
# Install dependencies
pip install -r requirements.txt
# Create .env file from template
cp .env.example .env
# Edit .env and add your API keys:
# - Get OpenAI API key from: https://platform.openai.com/api-keys
# - On any terminal Generate SECRET_KEY: python3 -c "import secrets; print(secrets.token_urlsafe(32))"
# Run database migrations (If you make changes to models, run these commands again)
1. Modify your model files (e.g., `app/models/user.py`)
2. Create migration on terminal: `alembic revision --autogenerate -m "Description" # Create new migration file
3. Apply migrations to DB Locally on terminal: alembic upgrade head
# Start backend server
uvicorn app.main:app --reloadBackend runs on: http://localhost:8000
Open a new terminal:
cd frontend
# Install dependencies
pnpm install
# Start development server
pnpm devFrontend runs on: http://localhost:5173
- Visit http://localhost:5173 - Should show "DocRelief AI" and "Backend Status: healthy"
- Visit http://localhost:8000/api/health - Should show
{"status": "healthy", "database": "connected"}
You need 3 terminals running:
Terminal 1 - PostgreSQL:
docker-compose up postgresTerminal 2 - Backend:
cd backend
source venv/bin/activate
uvicorn app.main:app --reloadTerminal 3 - Frontend:
cd frontend
pnpm devdocrelief-ai/
├── backend/
│ ├── app/
│ │ ├── api/
│ │ ├── models/
│ │ ├── schemas/
│ │ ├── services/
│ │ ├── db/
│ │ ├── main.py
│ │ └── config.py
│ ├── alembic/
│ ├── requirements.txt
│ └── .env.example
├── frontend/
│ ├── src/
│ ├── public/
│ └── package.json
├── docker-compose.yml
└── README.md
- Backend: Python, FastAPI, LangChain, OpenAI
- Frontend: React, Vite, Tailwind CSS
- Database: PostgreSQL
- Tools: Docker, Alembic, pnpm
git checkout main
git pull
git checkout -b feature/my-feature
# Make changes then commit:
git add .
git commit -m "feat: description"
git push origin feature/my-featureThen create PR on GitHub, it will be reviewed and merged.
- Oliver Rivera (Product Owner - CS 480)
- Ataide dos Santos (CS 380)
- Caio Vaz (CS 360)
- Brad Erickson (CS 360)