Jamcore

Backend API for Down2Jam.

Local Development

npm install
npm run dev

By default the API runs on http://localhost:3005.

Create a .env file with database and auth settings:

POSTGRES_USER=jammer
POSTGRES_PASSWORD=INSERTPASSWORDHERE
POSTGRES_DB=jamcore
TOKEN_SECRET=RANDOMSTRINGHERE

Docker

docker compose up --build -d

This starts Jamcore and its Postgres database.

Production

npm run build
npm start

Useful environment variables:

NODE_ENV=production
PORT=3005
CLIENT_ORIGIN=https://d2jam.com
DATABASE_URL=postgresql://user:password@host:5432/database
TOKEN_SECRET=RANDOMSTRINGHERE

Configuration

Optional app overrides can be placed in app.config.json or pointed to with APP_CONFIG_PATH. Use app.config.example.json as the starting point.

Health

• GET /healthz
• GET /readyz
• GET /metrics
• GET /api/v1/openapi