A production-grade REST API backend for team collaboration and task management, built with NestJS v11 and TypeScript.

CollabCore provides a complete, secure backend foundation for team-based productivity applications. It covers the full collaboration stack — authentication, teams, projects, tasks, comments, file attachments, real-time notifications, audit logging, and role-based access control — all production-hardened and ready to deploy.

• Tech Stack
• Module Overview
• Quick Start
• API Documentation
• Project Structure
• Development Commands
• Deployment
• Documentation Index

Resource hierarchy:

Team
 ├── Members (Users with team roles: owner / admin / member)
 └── Projects
      └── Tasks
           ├── Comments
           └── File Attachments

• Node.js v20+
• pnpm
• Docker & Docker Compose

git clone <repo-url>
cd collabcore-api
pnpm install

cp .env.example .env
# Edit .env with your local values (DB credentials, JWT secrets, etc.)

docker compose up -d
# Starts PostgreSQL (port 5432) and Redis (port 6379)

pnpm run migration:run   # Apply database schema
pnpm run seed            # Create default admin + test users (dev only)

pnpm run start:dev

The API is available at http://localhost:3000/api/v1. Interactive Swagger docs at http://localhost:3000/docs.

For the full setup guide including environment variable reference, see docs/getting-started/setup.md.

All responses follow a standard envelope:

{
  "success": true,
  "data": { },
  "message": "Operation successful",
  "timestamp": "2026-05-04T10:00:00.000Z",
  "path": "/api/v1/teams"
}

src/
├── main.ts                   # App bootstrap, global middleware
├── app.module.ts             # Root module
├── config/                   # Environment config & validation
├── common/                   # Shared guards, decorators, interceptors, filters
│   ├── decorators/
│   ├── filters/
│   ├── guards/
│   ├── interceptors/
│   ├── events/               # Domain event definitions (EventEmitter2)
│   └── middleware/
├── database/                 # TypeORM data source & migrations
└── modules/                  # Feature modules (one folder per domain)
    ├── auth/
    ├── users/
    ├── teams/
    ├── projects/
    ├── tasks/
    ├── comments/
    ├── files/
    ├── notifications/
    ├── audit-logs/
    ├── rbac/
    ├── health/
    └── mail/

Each feature module follows the same internal layout:

<feature>/
├── controllers/    # HTTP routing (thin)
├── services/       # Business logic
├── repositories/   # TypeORM queries
├── entities/       # Database entities
├── dtos/           # Validation & response shapes
└── <feature>.module.ts

# Development
pnpm run start:dev        # Watch mode
pnpm run start:debug      # Debug mode

# Build
pnpm run build
pnpm run start:prod       # Production mode

# Testing
pnpm run test             # Unit tests
pnpm run test:watch       # Watch mode
pnpm run test:cov         # Coverage report
pnpm run test:e2e         # End-to-end tests

# Database
pnpm run migration:run    # Apply pending migrations
pnpm run migration:revert # Revert last migration
pnpm run seed             # Seed dev data

# Quality
pnpm run lint
pnpm run format

The project is fully containerized with a multi-stage Dockerfile optimized for production.

# Build production image
docker build -t collabcore-api:prod .

# Run with environment file
docker run -p 3000:3000 --env-file .env.production collabcore-api:prod

A StartupChecksService validates database connectivity, Redis availability, environment variable completeness, and pending migrations before the server begins accepting requests.

See docs/api-reference/API_GUIDE.md for full deployment checklists for AWS (ECS + RDS + ElastiCache) and DigitalOcean (App Platform).

Built as a production-grade NestJS learning project. See CLAUDE.md for architectural guidelines.