Development Environment¶
Setting up a local dev environment takes about 5 minutes.
Prerequisites¶
Docker Engine 24+ and Docker Compose 2.20+
Python 3.12 (for running tests outside Docker)
Node.js 20+ (for frontend development)
Quick setup¶
git clone https://github.com/nilsonpmjr/Vantage.git
cd Vantage
cp .env.example .env
Edit .env — for development, set:
ENV=development
DEV_SEED_USERS=true
DEV_ADMIN_PASSWORD=DevAdmin123!
Warning
DEV_SEED_USERS=true automatically creates admin and tech users at startup.
Never set this in production — the backend will refuse to start.
Start the stack:
docker compose --profile dev up -d
The system will auto-initialize with dev users — no need to run setup:create-admin in
development mode.
Running backend tests¶
cd backend
python -m venv .venv && source .venv/bin/activate
pip install -r requirements-dev.txt
pytest -v
Or inside the container:
docker compose exec backend pytest -v
Running frontend dev server¶
cd web
npm install
npm run dev
The dev server runs at http://localhost:5173 and proxies API calls to the backend.
Type checking¶
cd web && npx tsc --noEmit
Code style¶
Backend:
rufffor linting and formattingFrontend: ESLint + Prettier (config in
web/package.json)
# Backend
cd backend && ruff check . && ruff format .
# Frontend
cd web && npm run lint