Home

🏠 Welcome to the Boilerplate Wiki

This boilerplate is designed to help you hit the ground running when building RESTful APIs using Express.js, TypeScript, and TSOA — all wrapped in a modular, scalable architecture. Whether you're launching a new service or standardizing API development across projects, this starter kit gives you a solid foundation built for velocity, safety, and developer experience.

---

🚀 Core Highlights

• Express.js for flexible, battle-tested HTTP handling
• Type-safe routing powered by TSOA
• Modular architecture that promotes clarity and maintainability
• Pre-configured middlewares for logging, error handling, security, and validation
• Integrated logger and Swagger/OpenAPI documentation out of the box

🧵 Background & Messaging Support

This boilerplate includes ready-to-use support for common background workflows:

• 🧵 BullMQ – Redis-backed job queues
• ⏰ Cron Jobs – Time-based task scheduling
• 🔄 Kafka – Distributed event streaming
• 📨 RabbitMQ – Message brokering for decoupled services
• 📡 Pusher – Real-time messaging and push notifications
• 🧠 In-memory Event Dispatcher – Lightweight pub-sub flows Each worker runs independently and can be deployed separately using Docker or PM2.

🛠️ Developer Tooling

To streamline development and enforce quality, the boilerplate includes:

• ⚡ SWC – Lightning-fast Rust-based TypeScript compiler
• 🔍 ESLint – Code linting and style enforcement
• ✨ Prettier – Automatic code formatting
• 🐶 Husky – Git hooks for pre-commit checks
• 🔁 PM2 – Production-grade process manager
• 🧪 Devcontainer support for VS Code
• 🐳 Docker base images for dev and prod environments It also integrates with custom open-source NPM utilities to simplify common tasks and enhance developer experience.

---

📚 Documentation Index

🚀 Core: Bootstrap & Configuration Guide

• 🧩 Bootstrap Guide Learn how the application initializes its lifecycle, DI container, and middleware stack.
• ⚙️ .Env Configuration Guide Understand how to manage environment variables securely and modularly.
• 🧱 Modules (Feature Implementation Guide) Explore the modular structure for scalable feature development.
• 🧪 Testing Guide Learn how to write integration and unit tests using supertest, expect, and node:test.

🔐 Security Guide

• 🛡️ AES Encryption & Decryption Guide Implement secure request/response encryption using AES wrappers and DTO validation.
• 🔐 JWT Auth Security Guide Authenticate users and protect routes using token-based security with HS256/RS256 strategies, role-based access control, and structured claim validation.
• 🔐 HMAC Auth Security Guide Validate request integrity using per-user HMAC signatures, timestamp-based expiry, and dynamic key resolution via client ID.

🧵 Worker Guide

• 🔄 In-Process Event Dispatch Guide Dispatch and handle domain events within the same process using a clean pub-sub pattern.
• ⏰ Cron Job Worker Guide Schedule and manage background tasks using cron-based workers.

⚙️ General Utilities Guide

• 📓 Logger Guide Structured logging with trace IDs and contextual metadata.
• 🧼 ExceptionWrapper Guide Standardized error handling with status codes and messages.
• 🛡️ GuardWrapper Guide Defensive programming patterns for runtime checks and guards.
• 🎯 Result and ResultFactory Guide Functional result handling for success/error flows.
• ✅ Validation Guide DTO validation using class-validator and custom decorators.