@ddd-framework

@ddd-framework is a comprehensive framework designed to facilitate the implementation of Domain-Driven Design (DDD) specifically for Node.js.

Introduction

This framework consists of a collection of packages that serve different purposes in order to support DDD practices effectively. These packages provide essential functionalities and tools that enable developers to seamlessly incorporate DDD principles into their Node.js applications. By leveraging @ddd-framework, developers can streamline their development process, enhance code organization, and create robust and maintainable applications based on the principles of DDD. It contains the following packages:

• @ddd-framework/collections
• @ddd-framework/core
• @ddd-framework/dto
• @ddd-framework/mongodb
• @ddd-framework/postgres
• @ddd-framework/seedwork
• @ddd-framework/uuid

Documentation

To access comprehensive TypeDoc-generated documentation for @ddd-framework, please refer to the official documentation.

Getting Started

Requirements:

• A Node.js stable version
• pnpm

After installing the requirements, run:

$ pnpm i
...
Progress: resolved 667, reused 662, downloaded 0, added 0, done
Copy

This will allow correct linting and running unit tests.

What's inside?

This monorepo uses pnpm as a package manager.

Commands

Following are commands that can be executed at root level with the help of the Turborepo API. These commands are configured inside the turbo.json file and serve as the monorepo pipeline.

build

To build all packages, run the following command:

$ pnpm build
...
@ddd-framework/seedwork:build: > tsc --project tsconfig.build.json
@ddd-framework/core:build: > tsc --project tsconfig.build.json
@ddd-framework/cqrs:build: > tsc --project tsconfig.build.json
@ddd-framework/event-sourcing:build: > tsc --project tsconfig.build.json

 Tasks:    4 successful, 4 total
Cached:    0 cached, 4 total
  Time:    3.571s 
Copy

dev

To optimally rebuild packages after code changes, run the following command:

$ pnpm dev
...
@ddd-framework/seedwork:build: > tsc --project tsconfig.build.json
@ddd-framework/seedwork:build: >
@ddd-framework/core:build: > tsc --project tsconfig.build.json
@ddd-framework/core:build: >
@ddd-framework/cqrs:build: > tsc --project tsconfig.build.json
@ddd-framework/cqrs:build: >
@ddd-framework/event-sourcing:build: > tsc --project tsconfig.build.json
@ddd-framework/event-sourcing:build: >
Copy

test

To test all packages, run the following command:

$ pnpm test
...

 Tasks:    6 successful, 6 total
Cached:    4 cached, 6 total
  Time:    9.487s 
Copy

License

The @ddd-framework is released under the MIT License. Feel free to customize it further to fit your needs.