Skip to main content

Prerequisites

  • Node.js >= 18
  • npm >= 9
  • Docker + Docker Compose (for local MySQL & Redis)
  • Git

Setup Steps

1. Clone the repo

2. Install dependencies

3. Configure environment

Copy or create a .env file in the project root. See Environment Variables for the full reference. At minimum you need the database, JWT secrets, and any integration keys you’re working with.

4. Start local services

This starts:
  • MySQL 8 on port 3306 — db: sahyogi, user: dbuser, password: sin90is1
  • Redis 7 on port 6380 — no auth (dev only)

5. Run migrations

To generate SQL migration files instead:

6. Seed the database (optional)

7. Start the dev server

The server runs on http://localhost:5001. The Vite frontend is served by Express (integrated, not a separate port).

Project Structure

Path aliases


Useful Commands