# api-backend

**Repository Path**: jvzhu/api-backend

## Basic Information

- **Project Name**: api-backend
- **Description**: Production-ready REST API backend with Express.js and TypeScript
- **Primary Language**: TypeScript
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-07-16
- **Last Updated**: 2026-07-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# api-backend

Production-ready REST API backend with Express.js, TypeScript, MongoDB, JWT authentication, Swagger docs, Docker, and CI.

## Features

- Express 5 + TypeScript setup
- MongoDB integration with Mongoose models and indexes
- JWT access/refresh token authentication with refresh token revocation
- Role-based access control for admin user management
- User and task CRUD APIs with pagination, filtering, sorting, and caching
- Request validation with Zod
- Global error handling, rate limiting, Helmet, CORS, and request logging
- Swagger UI at `/docs` and OpenAPI JSON at `/docs.json`
- Jest unit + integration tests with in-memory MongoDB
- Dockerfile, docker-compose, and GitHub Actions CI workflow

## Getting started

```bash
cp .env.example .env
npm install
npm run dev
```

The API starts on `http://localhost:3000`.

## Environment variables

See `.env.example` for all supported variables.

## Scripts

- `npm run dev` - start the development server
- `npm run build` - compile TypeScript to `dist/`
- `npm start` - run the compiled server
- `npm run lint` - type-check the project
- `npm test` - run the Jest test suite
- `npm run test:coverage` - generate coverage output

## API overview

### Health
- `GET /health`

### Authentication
- `POST /api/auth/register`
- `POST /api/auth/login`
- `POST /api/auth/refresh`
- `POST /api/auth/logout`
- `GET /api/auth/me`

### Users
- `POST /api/users` (admin)
- `GET /api/users` (admin)
- `GET /api/users/:id`
- `PUT /api/users/:id`
- `DELETE /api/users/:id` (admin)
- `GET /api/users/:id/profile`

### Tasks
- `POST /api/tasks`
- `GET /api/tasks`
- `GET /api/tasks/:id`
- `PUT /api/tasks/:id`
- `DELETE /api/tasks/:id`
- `PATCH /api/tasks/:id/complete`

## Docker

```bash
docker compose up --build
```

## CI

GitHub Actions runs type-checking, tests, and the production build on pushes and pull requests.