Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lequanphat/nestjs-starter-kit
A fundamental approach to start your NestJS application that is based on Hexagonal Architecture.
https://github.com/lequanphat/nestjs-starter-kit
bcrypt env-cmd handlebars husky i18n jwt lint-staged nestjs nodejs nodemailer passport postgresql swagger ts-node typeorm
Last synced: 19 days ago
JSON representation
A fundamental approach to start your NestJS application that is based on Hexagonal Architecture.
- Host: GitHub
- URL: https://github.com/lequanphat/nestjs-starter-kit
- Owner: lequanphat
- License: mit
- Created: 2024-10-22T08:34:57.000Z (23 days ago)
- Default Branch: main
- Last Pushed: 2024-10-24T16:15:02.000Z (21 days ago)
- Last Synced: 2024-10-25T22:37:32.178Z (20 days ago)
- Topics: bcrypt, env-cmd, handlebars, husky, i18n, jwt, lint-staged, nestjs, nodejs, nodemailer, passport, postgresql, swagger, ts-node, typeorm
- Language: TypeScript
- Homepage:
- Size: 610 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
[circleci-url]: https://circleci.com/gh/nestjs/nest
NestJS Starter Kit is based on Hexagonal Architecture
## Description
[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
## Features
- [x] Database. Support [TypeORM](https://www.npmjs.com/package/typeorm).
- [x] Migration and Seeding.
- [x] Config Service ([@nestjs/config](https://www.npmjs.com/package/@nestjs/config)).
- [x] Mailing ([nodemailer](https://www.npmjs.com/package/nodemailer)).
- [x] Sign in and sign up via email.
- [x] Admin and User roles.
- [x] Internationalization/Translations (I18N) ([nestjs-i18n](https://www.npmjs.com/package/nestjs-i18n)).
- [x] Swagger.
## Project setup
```bash
$ yarn install
```
## Compile and run the project
```bash
# development
$ yarn run start
# watch mode
$ yarn dev
# production mode
$ yarn run start:prod
```
## Hexagonal Architecture
## Description of the module structure
```txt
.
├── domain/
│ └── [DOMAIN].ts
├── dto/
│ ├── create.dto.ts
│ ├── update.dto.ts
│ └── get-all.dto.ts
├── infrastructure/
│ ├── entities/
│ │ └── [ENTITY].ts
│ ├── mappers/
│ │ └── [MAPPER].ts
│ └── repositories/
│ ├── [ADAPTER].repository.impl.ts
│ └── [PORT].repository.ts
├── controller.ts
├── module.ts
└── service.ts
```
`[DOMAIN].ts` represents an entity used in the business logic. Domain entity has no dependencies on the database or any other infrastructure.
`[ENTITY].ts` represents the **database structure**. It is used in the relational database.
`[MAPPER].ts` is a mapper that converts **database entity** to **domain entity** and vice versa.
`[PORT].repository.ts` is a repository **port** that defines the methods for interacting with the database.
`[ADAPTER].repository.impl.ts` is a repository that implements the `[PORT].repository.ts`. It is used to interact with the database.
## License
Nest is [MIT licensed](https://github.com/nestjs/nest/blob/master/LICENSE).