Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nestjs-mod/nestjs-mod
A collection of utilities for unifying NestJS applications and modules
https://github.com/nestjs-mod/nestjs-mod
application mod modules nestjs nestjs-mod
Last synced: 2 months ago
JSON representation
A collection of utilities for unifying NestJS applications and modules
- Host: GitHub
- URL: https://github.com/nestjs-mod/nestjs-mod
- Owner: nestjs-mod
- License: mit
- Created: 2024-01-06T17:16:27.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-11-03T10:02:17.000Z (2 months ago)
- Last Synced: 2024-11-06T07:40:50.129Z (2 months ago)
- Topics: application, mod, modules, nestjs, nestjs-mod
- Language: TypeScript
- Homepage:
- Size: 2.07 MB
- Stars: 6
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
A collection of utilities for unifying NestJS applications and modules.
## Description
NestJS is a great framework and you can do great things with it, but often when developing a large number of applications within the same organization, we end up with different application architectures, file structures, and a lot of duplicate code.
The NestJS-mod collection of utilities are designed to unify applications and modules, and also introduce new logical options for dividing responsibilities between modules (Core, Feature, Integration, System, Infrastructure).
Since all parts of the application are unified, you can create a report on the entire project infrastructure.
## Getting started
### Create new application
Commands for create empty NestJS-mod application
```bash
# Create empty nx project
npx --yes [email protected] --name=project-name --preset=apps --interactive=false --ci=skip
# Go to created project
cd project-name
# Install all need main dev-dependencies
npm install --save-dev @nestjs-mod/schematics@latest
# Create NestJS-mod application
./node_modules/.bin/nx g @nestjs-mod/schematics:application --directory=apps/app-name --name=app-name --projectNameAndRootFormat=as-provided --strict=true
```
Start created application
```bash
# Prepare all files
npm run manual:prepare
# Start application in dev mode
npm run serve:dev:app-name
# Build and start application in prod mode
## Build
npm run build:prod:app-name
## Start
npm run start:prod:app-name
```
### Create new library
Commands for create empty NestJS-mod library
```bash
# Create NestJS-mod library
./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`
```ts
// Example without options
bootstrapNestApplication({
...
modules: {
feature: [FeatureName.forRoot()],
}
});
// Example with options
bootstrapNestApplication({
...
modules: {
feature: [FeatureName.forRoot({
configuration: { optionsName: 'options name' },
})],
}
});
// By default, in the example, the application looks for env by the key `APP_NAME_ENV_NAME`, but you can override it, for example:
bootstrapNestApplication({
...
modules: {
feature: [FeatureName.forRoot({
environments: { envName: 'env name' },
})],
}
});
```
### Create an infrastructure report
You can generate a report for all modules and their configurations.
```bash
# Generate markdown report
npm 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/tree/master/libs/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](https://t.me/nestjs_mod) or [Discord](https://discord.gg/meY7UXaG). The issue list of this repo is **exclusively** for bug reports and feature requests.
## Stay in touch
- Author - [Ilshat Khamitov](https://t.me/KaufmanEndy)
## License
MIT