create-ts-downstream-boilerplate
v1.3.6
Published
A Node.js + TypeScript boilerplate for calling downstream APIs using Controller → Service → Adapter pattern with Circuit Breaker.
Downloads
798
Maintainers
Readme
create-ts-downstream-boilerplate
A Node.js + TypeScript boilerplate generator for creating downstream API applications using the Controller → Service → Adapter pattern with Circuit Breaker implementation.
Features
- 🏗️ Clean Architecture: Controller → Service → Adapter pattern
- 🔄 Circuit Breaker: Built-in fault tolerance for downstream API calls
- 🔒 TypeScript: Full TypeScript support with strict configuration
- 🚀 Express.js: Fast and minimal web framework
- 📦 Ready to use: Includes HTTP client and error handling
- 🎯 Template replacement: Automatically replaces
__APP_NAME__placeholders
Quick Start
Create a new project using npx (no installation required):
npx create-ts-downstream-boilerplate my-project-nameSetup your new project
cd my-project-name
npm install
npm run devAvailable Scripts
npm run dev- Start development server with hot reloadnpm run build- Build TypeScript to JavaScriptnpm start- Start production server
Architecture Pattern
This boilerplate implements a clean, scalable architecture:
- Controller: Handles HTTP requests/responses
- Service: Contains business logic
- Adapter: Manages external API communication
- Circuit Breaker: Provides fault tolerance
Author
Madhuri Badgujar
- Email: [email protected]
- GitHub: @madhubadgujar
