Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ecaminero/nestjs-ddd
Nestjs DDD
https://github.com/ecaminero/nestjs-ddd
ddd-architecture nodejs npm programming typescript yarn
Last synced: 2 months ago
JSON representation
Nestjs DDD
- Host: GitHub
- URL: https://github.com/ecaminero/nestjs-ddd
- Owner: ecaminero
- License: unlicense
- Created: 2019-07-04T00:19:15.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-01-06T12:12:34.000Z (about 1 year ago)
- Last Synced: 2024-08-04T18:02:32.743Z (6 months ago)
- Topics: ddd-architecture, nodejs, npm, programming, typescript, yarn
- Language: TypeScript
- Homepage:
- Size: 215 KB
- Stars: 186
- Watchers: 7
- Forks: 32
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NestJs Clean Arquitecture
Mutation test - stiker
This is an example of using DDD with nestjs, only for proof of concept and framework study
If you want more documentation of it, click here [Nest](https://github.com/nestjs/nest)
[A quick introduction to clean architecture](https://www.freecodecamp.org/news/a-quick-introduction-to-clean-architecture-990c014448d2/)
## Branch Definitions
* **master**: Flat structure with mongo connection
* **flat-structure-sql**: Flat structure with connection to sqlite can be easily changed to any connection that allows sequelizejs
* **hexagonal-architecture**: Exagonal structure with mongo connection
## Getting Started
```
git clone [email protected]:ecaminero/nestjs-ddd.git
```
### Structure
```
.
├── doc
│ ├── *.http
├── src
│ ├── app
│ │ ├── __test__
│ │ │ └── *.controller.spec.ts
│ │ ├── controller
│ │ │ └── *.controller.ts
│ │ ├── dto
│ │ │ └── *.dto.ts
│ │ ├── interceptors
│ │ │ └── *.interceptor.ts
│ │ └── middlewere
│ │ └── *.middleware.ts
│ ├── domain
│ │ ├── __test__
│ │ │ └── *.service.spec.ts
│ │ ├── entities
│ │ │ └── *.entity.ts
│ │ └── service
│ │ └── *.service.ts
│ ├── infrastructure
│ │ ├── database
│ │ │ └── *.providers.ts
│ │ ├── health
│ │ │ └── *.check.ts
│ │ ├── model
│ │ │ └── *.model.ts
│ │ └── repository
│ │ └── *.repository.ts
│ ├── main.ts
│ ├── app.module.ts
│ ├── constants.ts
├── test
│ ├── app.e2e-spec.ts
│ └── jest-e2e.json
├── jest.config.json
├── localhost.sqlite
├── nest-cli.json
├── nodemon-debug.json
├── nodemon.json
├── package-lock.json
├── package.json
├── README.md
├── tsconfig.build.json
├── tsconfig.json
└── tslint.json
```
### Prerequisites
* node 10+
* mongo DB
* Sqlite
```bash
$ docker run --name dev-mongo -p 27017:27017 -d mongo
```
### Installing
```bash
$ npm install
```
If you see this everything all fine
```
added 898 packages from 578 contributors and audited 876746 packages in 11.087s
found 0 vulnerabilities
```
## Running the tests
```bash
# unit tests
$ npm run test
# e2e tests
$ npm run test:e2e
# coverage
$ npm run test:cov
```
## Built With
* [Nest](https://github.com/nestjs/nest) - The framework used
* [Mongoosejs](https://mongoosejs.com/) - elegant object modeling for Nodejs
* [node.js](https://nodejs.org/en/)- Node.js® is a JavaScript runtime built on Chrome's V8 JavaScript engine
* [jestjs](https://jestjs.io/en/) Jest is a delightful JavaScript Testing Framework with a focus on simplicity
* [sequelizejs](http://docs.sequelizejs.com/) Sequelize is a promise-based Node.js ORM for Postgres, MySQL, MariaDB, SQLite and Microsoft SQL Server. It features solid transaction support, relations, eager and lazy loading, read replication and more.
## Authors
* **Edwin Caminero** - *Initial work* - [github](https://github.com/ecaminero)
See also the list of [contributors](https://github.com/ecaminero/nestjs-ddd/contributors) who participated in this project.
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
## Acknowledgments
* Inspiration
* Hexagonal architecture concept tests