A collection of utilities for unifying NestJS applications and modules.

Description

This repository contains modules prepared for the application launched via NestJS-mod.

Some modules are written from scratch, and some are a wrapped version of existing NestJS modules.

Types of modules (list in order of processing):

• System modules - System modules necessary for the operation of the entire application (examples: launching a NestJS application, launching microservices, etc.). Only NestJS-mod compatible modules.
• Core modules - Core modules necessary for the operation of feature and integration modules (examples: main module with connection to the database, main module for connecting to aws, etc.). NestJS and NestJS-mod compatible modules.
• Feature modules - Feature modules with business logic of the application. NestJS and NestJS-mod compatible modules.
• Integration modules - Integration modules are necessary to organize communication between feature or core modules (example: after creating a user in the UsersModule feature module, you need to send him a letter from the NotificationsModule core module). NestJS and NestJS-mod compatible modules.
• Infrastructure modules - Infrastructure modules are needed to create configurations that launch various external services (examples: docker-compose file for raising a database, gitlab configuration for deploying an application). Only NestJS-mod compatible modules.

Getting started

Create new application

Commands for create empty NestJS-mod application

1# Create empty nx project
2npx --yes create-nx-workspace@19.5.3 --name=project-name --preset=apps --interactive=false --ci=skip
3
4# Go to created project
5cd project-name
6
7# Install all need main dev-dependencies
8npm install --save-dev @nestjs-mod/schematics@latest
9
10# Create NestJS-mod application
11./node_modules/.bin/nx g @nestjs-mod/schematics:application --directory=apps/app-name --name=app-name --projectNameAndRootFormat=as-provided --strict=true

Start created application

1# Prepare all files
2npm run manual:prepare
3
4# Start application in dev mode
5npm run serve:dev:app-name
6
7# Build and start application in prod mode
8
9## Build
10npm run build:prod:app-name
11
12## Start
13npm run start:prod:app-name

Create new library

Commands for create empty NestJS-mod library

1# Create NestJS-mod library
2./node_modules/.bin/nx g @nestjs-mod/schematics:library feature-name --buildable --publishable --directory=libs/feature-name --simpleName=true --projectNameAndRootFormat=as-provided --strict=true

Add created library to apps/app-name/src/main.ts

1
2// Example without options
3bootstrapNestApplication({
4  ...
5  modules: {
6    feature: [FeatureName.forRoot()],
7  }
8});
9
10// Example with options
11bootstrapNestApplication({
12  ...
13  modules: {
14    feature: [FeatureName.forRoot({
15      configuration: { optionsName: 'options name' },
16    })],
17  }
18});
19
20
21// By default, in the example, the application looks for env by the key `APP_NAME_ENV_NAME`, but you can override it, for example:
22bootstrapNestApplication({
23  ...
24  modules: {
25    feature: [FeatureName.forRoot({
26      environments: { envName: 'env name' },
27    })],
28  }
29});

Create an infrastructure report

You can generate a report for all modules and their configurations.

1# Build all applications and library
2npm run build
3
4# Generate markdown report
5npm run docs:infrastructure

After which the file INFRASTRUCTURE.MD appear in the application folder apps/app-name.

Links

• https://github.com/nestjs-mod/nestjs-mod - A collection of utilities for unifying NestJS applications and modules
• https://github.com/nestjs-mod/nestjs-mod-contrib - Contrib repository for the NestJS-mod
• https://github.com/nestjs-mod/nestjs-mod-example - Example application built with @nestjs-mod/schematics
• https://github.com/nestjs-mod/nestjs-mod/blob/master/apps/example-basic/INFRASTRUCTURE.MD - A simple example of infrastructure documentation.
• https://github.com/nestjs-mod/nestjs-mod-contrib/blob/master/apps/example-prisma/INFRASTRUCTURE.MD - An extended example of infrastructure documentation with a docker-compose file and a data base.
• https://dev.to/endykaufman/collection-of-nestjs-mod-utilities-for-unifying-applications-and-modules-on-nestjs-5256 - Article about the project NestJS-mod
• https://habr.com/ru/articles/788916 - Коллекция утилит NestJS-mod для унификации приложений и модулей на NestJS

Questions

For questions and support please use the official Telegram group or Discord. The issue list of this repo is exclusively for bug reports and feature requests.

Stay in touch

• Author - Ilshat Khamitov

License

MIT