Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hantsy/nestjs-rest-sample
NestJS RESTful APIs Sample
https://github.com/hantsy/nestjs-rest-sample
expressjs jest mongoose nestjs nestjs-mongoose restful-api rxjs typescript
Last synced: 30 days ago
JSON representation
NestJS RESTful APIs Sample
- Host: GitHub
- URL: https://github.com/hantsy/nestjs-rest-sample
- Owner: hantsy
- License: gpl-3.0
- Created: 2020-06-05T13:09:20.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-09-23T14:08:33.000Z (about 2 months ago)
- Last Synced: 2024-09-27T18:23:01.571Z (about 1 month ago)
- Topics: expressjs, jest, mongoose, nestjs, nestjs-mongoose, restful-api, rxjs, typescript
- Language: TypeScript
- Homepage: https://hantsy.github.io/nestjs-rest-sample/
- Size: 9.54 MB
- Stars: 414
- Watchers: 8
- Forks: 97
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NestJS Sample
[](https://codecov.io/gh/hantsy/nestjs-rest-sample)
A NestJS RESTful APIs sample project, including:
* Restful APIs satisfies Richardson Maturity Model(Level 2)
* Custom Mongoose integration module instead of @nestjs/mongoose
* Passport/Jwt authentication with simple text secrets
* Fully testing codes with Jest, jest-mock-extended, ts-mockito, @golevelup/ts-jest etc.
* Github actions workflow for continuous testing, code coverage report, docker image building, etc.
## Docs
* [Getting Started](./docs/guide.md)
* [Connecting to MongoDB](./docs/mongo.md)
* [Protect your APIs with JWT Token](./docs/auth.md)
* [Dealing with model relations](./docs/model.md)
* [Externalizing the configuration](./docs/config.md)
* [Handling user registration](./docs/user.md)
* [Testing Nestjs applications](./docs/testing.md)
## Build
Install the dependencies.
```bash
$ npm install
```
Running the app
```bash
# development
$ npm run start
# watch mode
$ npm run start:dev
# production mode
$ npm run start:prod
```
Test
```bash
# unit tests
$ npm run test
# e2e tests
$ npm run test:e2e
# test coverage
$ npm run test:cov
```
## Reference
* [The official Nestjs documentation](https://docs.nestjs.com/first-steps)
* [Unit testing NestJS applications with Jest](https://blog.logrocket.com/unit-testing-nestjs-applications-with-jest/)
* [ts-mockito: Mocking library for TypeScript inspired by http://mockito.org/](https://github.com/NagRock/ts-mockito)
* [Clock-in/out System Series](https://carloscaballero.io/part-2-clock-in-out-system-basic-backend/)
* [Modern Full-Stack Development with Nest.js, React, TypeScript, and MongoDB: Part 1](https://auth0.com/blog/modern-full-stack-development-with-nestjs-react-typescript-and-mongodb-part-1/), [Part 2](https://auth0.com/blog/modern-full-stack-development-with-nestjs-react-typescript-and-mongodb-part-2/)
* [Code with Hugo - Jest Full and Partial Mock/Spy of CommonJS and ES6 Module Imports](https://codewithhugo.com/jest-mock-spy-module-import/)
* There is a collection of courses from [https://wanago.io/](https://wanago.io/) which is very helpful for building applications with NestJS:
* [API with NestJS](https://wanago.io/courses/api-with-nestjs/)
* [Series: TypeScript Express tutorial](https://wanago.io/courses/typescript-express-tutorial/)
* [Series: Node.js TypeScript](https://wanago.io/courses/node-js-typescript/)
* [Series: JavaScript testing tutorial](https://wanago.io/courses/javascript-testing-tutorial/)