Skip to main content

Development Setup

Backend Development

cd conformly-backend
python -m venv venv
source venv/bin/activate
pip install -r requirements.txt
pip install -r requirements-dev.txt  # If available

Frontend Development

cd conformly-frontend
npm install
npm run dev

Running Tests

Backend

cd conformly-backend
pytest

Frontend

cd conformly-frontend
npm test

Code Formatting

Backend

black app/
isort app/
flake8 app/

Frontend

npm run lint
npm run format

Development Workflow

  1. Create a feature branch
  2. Make your changes
  3. Run tests
  4. Format code
  5. Commit changes
  6. Push and create PR

Hot Reload

Both backend and frontend support hot reload during development:
  • Backend: FastAPI auto-reloads on file changes
  • Frontend: Vite HMR (Hot Module Replacement)

Debugging

Backend

  • Use FastAPI’s interactive docs at /docs
  • Check logs in logs/ directory
  • Use Python debugger (pdb)

Frontend

  • Use browser DevTools
  • React DevTools extension
  • Check console for errors

Contributing Guide

Learn about contributing to Conformly.ai