https://github.com/locngoduc/nodejs-typescript-ddd-boilerplate
Build Node.js applications with TypeScript and Domain Driven Design (DDD) principles. Includes Redis caching, MongoDB (Mongoose), JWT authentication, and Swagger for API docs. Ideal for scalable, maintainable backend projects.
https://github.com/locngoduc/nodejs-typescript-ddd-boilerplate
domain-driven-design expressjs jwt mongoose nodejs redis typescript
Last synced: 3 months ago
JSON representation
Build Node.js applications with TypeScript and Domain Driven Design (DDD) principles. Includes Redis caching, MongoDB (Mongoose), JWT authentication, and Swagger for API docs. Ideal for scalable, maintainable backend projects.
- Host: GitHub
- URL: https://github.com/locngoduc/nodejs-typescript-ddd-boilerplate
- Owner: locngoduc
- Created: 2024-07-16T08:27:15.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-16T08:56:03.000Z (almost 2 years ago)
- Last Synced: 2025-03-06T05:24:14.195Z (over 1 year ago)
- Topics: domain-driven-design, expressjs, jwt, mongoose, nodejs, redis, typescript
- Language: TypeScript
- Homepage:
- Size: 13.7 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Node.js TypeScript DDD Boilerplate
[](https://nodejs.org/)
[](https://www.typescriptlang.org/)
[](https://redis.io/)
[](https://www.mongodb.com/)
[](https://jwt.io/)
[](https://swagger.io/)
A boilerplate for building Node.js applications using TypeScript and Domain-Driven Design principles. This setup includes Redis for caching, MongoDB via Mongoose for database operations, JWT for authentication, and Swagger for API documentation.
## Table of Contents
- [Features](#features)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Configuration](#configuration)
- [Running the Application](#running-the-application)
- [Project Structure](#project-structure)
- [application](#application)
- [config](#config)
- [domain](#domain)
- [infrastructure](#infrastructure)
- [interface](#interface)
- [shared](#shared)
- [template](#template)
- [worker](#worker)
- [Contributing](#contributing)
- [License](#license)
---
## Features
- **TypeScript:** Write code in TypeScript for improved type safety and maintainability.
- **Domain-Driven Design (DDD):** Organize your application into distinct layers based on domain concepts.
- **Redis:** Utilize Redis for caching to improve application performance.
- **MongoDB with Mongoose:** Interact with MongoDB using the Mongoose ORM for schema management.
- **JWT Authentication:** Secure your APIs with JSON Web Tokens for authentication and authorization.
- **Swagger:** Automatically generate API documentation with Swagger.
## Getting Started
### Prerequisites
Ensure you have Node.js (v14.17 or higher) and npm installed on your machine.
### Installation
1. **Clone the repository:**
```bash
git clone https://github.com/VaderNgo/Typescript-Nodejs-DDD-Boilerplate.git
```
2. **Install Dependencies**
```bash
npm install
```
### Configuration
Create a .env file based on .env.example and configure your environment variables, including MongoDB connection URI, Redis server details, JWT secret, etc.
# Project Structure
```bash
/src
│
├── /application # Use cases and business logic implementations
├── /config # Configuration files (database, authentication, etc.)
├── /domain # Domain entities, repositories, services
├── /infrastructure # Adapters for external interfaces (MongoDB, Redis, etc.)
├── /interface # API controllers, GraphQL resolvers, etc.
├── /shared # Shared utilities, constants, and cross-cutting concerns
├── /template # Template rendering logic (if applicable)
└── /worker # Background job processing logic (if applicable)
```
### application
Contains use cases and business logic implementations that orchestrate interactions between domain entities and infrastructure services.
### config
Houses configuration files such as database connections, authentication settings, and environment variables.
### domain
Defines domain entities, repositories for data access, and services encapsulating core business logic.
### infrastructure
Implements adapters for external interfaces like databases (MongoDB with Mongoose), caching (Redis), external APIs, etc.
### interface
Handles external communication interfaces such as API controllers, GraphQL resolvers, WebSocket handlers, etc.
### shared
Includes shared utilities, helper functions, constants, and other cross-cutting concerns used across different layers.
### template
Deals with template rendering logic if your application sends templated emails or generates documents.
### worker
Contains background job processing logic using task queues or job schedulers (like Bull, Agenda, etc.) if applicable.
# Contributing
Contributions are welcome! Fork the repository and submit pull requests.