https://github.com/0xtheprodev/nestjs-clean-example
Clean Architecture Example using NestJS on Fastify
https://github.com/0xtheprodev/nestjs-clean-example
clean-architecture fastify graphql hexagonal-architecture nestjs openapi openapi3 repository-pattern rest-api swagger-ui typeorm typescript
Last synced: 12 days ago
JSON representation
Clean Architecture Example using NestJS on Fastify
- Host: GitHub
- URL: https://github.com/0xtheprodev/nestjs-clean-example
- Owner: 0xTheProDev
- License: mit
- Created: 2022-06-27T07:53:29.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-05-12T09:03:17.000Z (about 2 years ago)
- Last Synced: 2025-02-28T06:57:51.307Z (4 months ago)
- Topics: clean-architecture, fastify, graphql, hexagonal-architecture, nestjs, openapi, openapi3, repository-pattern, rest-api, swagger-ui, typeorm, typescript
- Language: TypeScript
- Homepage:
- Size: 812 KB
- Stars: 6
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# nestjs-clean-example
[](https://typescriptlang.org/)
[](https://nodejs.org/)
[](https://nestjs.com/)
[](https://www.fastify.io/)
[](https://www.openapis.org/)
[](https://graphql.org/)
[](https://eslint.org)
[](https://prettier.io)
[](https://github.com/0xTheProDev/nestjs-clean-example/issues)
[](https://github.com/0xTheProDev/nestjs-clean-example/issues?q=is%3Aissue+is%3Aclosed)
[](https://github.com/0xTheProDev/nestjs-clean-example/pulls)
[](https://github.com/0xTheProDev/nestjs-clean-example/pulls?q=is%3Apr+is%3Aclosed)
[](https://github.com/0xTheProDev/nestjs-clean-example/graphs/contributors)
[](https://github.com/0xTheProDev/nestjs-clean-example/pulse)## Description
_Example Application Interface using NestJS framework in TypeScript_
This example showcases Repository Pattern in Hexagonal Architecture _(also known as Clean Architecture)_. Here we have two Entities - Books and Authors, whose relationships have been exploited to create CRUD endpoint in REST under OpenAPI standard.
## Installation
- Install all the project dependency using [Yarn](https://yarnpkg.com):
```sh
$ yarn
```- Run the application from command prompt:
```sh
$ yarn start
```## Testing
- Run the following command to initiate Unit test:
```sh
$ yarn test
```
- Run the following command to initiate E2E test:
```sh
$ yarn test:e2e
```## License
© MIT License