🚀 Ultimate TypeScript Express Boilerplate

✨ Features

• Unified Message Bus with transport-aware routing for BullMQ, Kafka, and RabbitMQ.
• Parallel Worker Runtime with dedicated worker entrypoints for queue/event/command processing.
• BullMQ by Default for delayed/retryable jobs with optional Kafka and RabbitMQ integrations.
• Authentication + Security with JWT access/refresh rotation, refresh reuse detection, RBAC guard, and Redis-backed rate limiting.
• Stripe Webhooks with signature verification, idempotency protection, and async dispatch via queue workflows.
• Observability with OpenTelemetry tracing, Prometheus metrics, structured logging, and capability diagnostics.
• OpenAPI + Contract Checks with Swagger docs export and Spectral linting.
• Strict CI Quality Gate covering typecheck, lint, tests, contracts, and security audit.
• Migration + Seeding Support with migrate-mongo and seed scripts.
• Docker + Kubernetes Ready with local stack orchestration and production manifests.

---

⚡ Quick Start

1. Prerequisites

Install the following:

• Node.js (v20+ recommended)
• npm
• Docker Desktop for dev:stack (optional but recommended)

2. Clone

git clone https://github.com/Nayem-Dev/TS_Backend.git
cd TS_Backend/TS_Boiler_Plate

3. Install

npm install

4. Configure Environment

cp .env.example .env

Set required values in .env:

DB_TYPE=mongodb
MONGODB_URL=mongodb://localhost:27017/ts_boilerplate
REDIS_URL=redis://localhost:6379

BULLMQ_ENABLED=true
KAFKA_ENABLED=true
RABBITMQ_ENABLED=true
STRIPE_ENABLED=false

5. Run

• API only:

npm run dev

• Full local stack (API + workers + infra via Docker):

npm run dev:stack

---

📂 Project Structure

TS_Boiler_Plate/
├── src/
│   ├── app.ts
│   ├── server.ts
│   ├── auth/
│   ├── config/
│   ├── database/
│   ├── jobs/
│   ├── lib/
│   ├── messaging/          # Unified message bus
│   ├── modules/
│   ├── observability/
│   ├── payments/
│   ├── queues/
│   ├── routes/
│   ├── workers/            # Dedicated worker entrypoints
│   └── utils/
├── docker-compose.yml
├── k8s/
└── scripts/

---

🛠️ Scripts Overview

Command	Description
npm run dev	Start API in dev mode
npm run dev:stack	Start API + workers + infra (Docker Compose)
npm run worker:bullmq	Run BullMQ worker
npm run worker:kafka	Run Kafka consumer worker
npm run worker:rabbitmq	Run RabbitMQ consumer worker
npm run typecheck	Run strict TypeScript checks
npm run lint	Run ESLint
npm run test	Run Vitest suites
npm run check:contracts	Export OpenAPI + run Spectral lint
npm run check:security	Run npm audit gate
npm run check:all	Run full quality gate
npm run migrate:up	Apply Mongo migrations
npm run seed	Run seed data

---

🔎 Diagnostics Endpoints

• GET /api/v1/health
• GET /api/v1/ready
• GET /api/v1/system/capabilities
• GET /api/v1/system/pipeline-ready
• GET /metrics

---

🤝 Contributing

Contributions are welcome. Please ensure npm run check:all passes before opening a PR.