TypeScript Backend Toolkit
A robust backend boilerplate designed for scalability, flexibility, and ease of development. Packed with modern technologies and best practices to kickstart your next backend project.
# Start MongoDB and Redis
docker compose up -d
# Install dependencies
pnpm install
# Start development server
pnpm run dev
🚀 Server running at http://localhost:3000
📚 API Docs: http://localhost:3000/api-docs
📊 Queue Dashboard: http://localhost:3000/admin/queuesWhat's Included
OpenAPI Docs
Auto-generated Swagger documentation through MagicRouter API and Zod for perfect type safety
Auth Module
Complete authentication system with Google Sign-In support and JWT handling
User Management
Comprehensive user management with role-based access control and profile handling
File Upload
Seamless file uploads with Multer and Amazon S3 integration for scalable storage
Data Validation
Type-safe data validation and serialization powered by Zod
Config Management
Environment configuration with dotenv-cli and Zod validation for type safety
Before You Start
To ensure a smooth development experience, make sure you have these essential tools installed. They form the foundation of your development environment and are crucial for running the project efficiently.
Docker + Docker Compose
Required for running MongoDB and Redis services in isolated containers
PNPM
Fast, disk space efficient package manager for managing dependencies
Node.js 20+ (LTS)
Latest LTS version for optimal performance and security
What's Next
Our development roadmap outlines exciting features and improvements planned for future releases. These additions will enhance scalability, developer experience, and deployment options.
Real-time Support
Socket.io integration with Redis adapter for scalable real-time communication
Advanced Notifications
FCM & Novu integration for powerful, multi-channel notifications
Server Automation
Ansible playbooks for automated server provisioning and configuration
Cloud Infrastructure
AWS CDK support for infrastructure as code and easy cloud deployment
Monorepo Structure
Turborepo integration for efficient monorepo management
Serverless Ready
Support for AWS Lambda and Cloudflare Workers deployment