This is a Node.js server that implements Domain-Driven Design (DDD) in a minimalistic way. The main purpose of this server is to focus on business logic and be agnostic to any transport or protocol.
The server has two entities, namely Driver
and WorkShift
. A driver can have multiple shifts. Instead of using an ORM, the server uses manual mapping from SQL queries to domain entities. The server implements dependency injection using tsyringe
library.
The server supports two different transports: HTTP (fastify
) and WebSocket (uWebSocket.js
).
The documentation is generated using Docusaurus
, and can be found in the ./apps/docs
folder.
pnpm
: package managertsx
: local TS development & file watchingtsc
: TS lintingtsc-alias
: replacing paths aliases (such as@api, @domain and @infrastrcuture
) with relative pathsesbuild
: TS -> JS compilationnode:test
: node.js native test runnerknex
: query builder & migrationschance
: generating random datazod
: validation & schema defsdocusaurus
: API docstsyringe
: DI libraryuWebSockets.js
: C++ implementation of WebSocketsfastify
: HTTP frameworkTurborepo
: build system for monorepo - https://turbo.build/repo
Run the following command:
npx create-turbo@latest
This Turborepo includes the following packages/apps:
docs
: docusaurus appserver
: backendeslint-config-custom
:eslint
configurations (includeseslint-config-next
andeslint-config-prettier
)tsconfig
:tsconfig.json
s used throughout the monorepo
This Turborepo has some additional tools already setup for you:
- TypeScript for static type checking
- ESLint for code linting
- Prettier for code formatting
To build all apps and packages, run the following command:
cd node-ddd-monorepo
pnpm build
To develop all apps and packages, run the following command:
cd node-ddd-monorepo
pnpm dev
Turborepo can use a technique known as Remote Caching to share cache artifacts across machines, enabling you to share build caches with your team and CI/CD pipelines.
By default, Turborepo will cache locally. To enable Remote Caching you will need an account with Vercel. If you don't have an account you can create one, then enter the following commands:
cd node-ddd-monorepo
npx turbo login
This will authenticate the Turborepo CLI with your Vercel account.
Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your Turborepo:
npx turbo link
Learn more about the power of Turborepo: