Lean, TypeScript-first API powering HireMind's user profile and interview experiences. Currently undergoing a clean-room rewrite focused on five core endpoints and zero bloat.
- Minimal surface: only
/health,/user/me, and/interview/*endpoints survive the purge. - Strict typing: end-to-end TypeScript with lightweight domain models.
- Mongo-ready: thin connection layer (re)built for fast local dev + easy Atlas deploys.
- Ship-fast mindset: tiny middleware stack, opinionated API responses, batteries-optional.
| Method | Path | Purpose |
|---|---|---|
GET |
/health |
Infra heartbeat + uptime snapshot |
GET |
/user/me |
Return the authenticated HireMind user |
POST |
/interview/start |
Open a new mock interview session |
POST |
/interview/message |
Send conversation turns within a session |
GET |
/interview/history |
Fetch the user's recent interview transcripts |
- Install:
cd backend && npm install - Configure: copy
.env.example→.envand set the essentials below. - Run:
npm run dev(hot reload) ornpm run build && npm startfor production smoke tests.
| Variable | Description | Example |
|---|---|---|
PORT |
HTTP port | 4000 |
NODE_ENV |
development | production |
development |
MONGODB_URI |
Mongo connection string | mongodb://localhost:27017/hiremind |
CORS_ORIGIN |
Allowed frontend origin(s) | http://localhost:3000 |
| Command | Description |
|---|---|
npm run dev |
Start the TypeScript watcher + nodemon dev server |
npm run build |
Compile to dist/ via tsc |
npm start |
Serve the compiled build |