Skip to content

Setup and Development

Karthik edited this page Mar 1, 2026 · 1 revision

Setup and Development

Prerequisites

  • Node.js and npm (frontend)
  • Python 3.11+ (backend scripts/tests)
  • AWS CLI (for cloud integration)
  • AWS CDK CLI (for infra deployment)

Local Bootstrap

Windows

scripts\setup\setup-local.bat
scripts\setup\start-local.bat

Linux/macOS

chmod +x scripts/setup/setup-local.sh scripts/setup/start-local.sh
./scripts/setup/setup-local.sh
./scripts/setup/start-local.sh

Frontend Only

cd frontend
npm install
npm start

Environment Configuration

  • Use template env files (for example .env.example).
  • Keep secrets out of Git.
  • Prefer per-environment files for local/stage/prod separation.

Recommended Dev Workflow

  1. Create a feature branch.
  2. Make small, scoped changes.
  3. Run relevant tests locally.
  4. Open PR with clear validation notes.

Clone this wiki locally