Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thisismydesign/nestjs-starter
NestJS MVC boilerplate for rapid development with battle-tested standards.
https://github.com/thisismydesign/nestjs-starter
boilerplate nestjs nextjs typescript
Last synced: about 2 months ago
JSON representation
NestJS MVC boilerplate for rapid development with battle-tested standards.
- Host: GitHub
- URL: https://github.com/thisismydesign/nestjs-starter
- Owner: thisismydesign
- Created: 2021-02-06T10:55:54.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-04-04T08:44:33.000Z (6 months ago)
- Last Synced: 2024-07-11T14:46:34.071Z (2 months ago)
- Topics: boilerplate, nestjs, nextjs, typescript
- Language: TypeScript
- Homepage:
- Size: 2.12 MB
- Stars: 465
- Watchers: 8
- Forks: 79
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# NestJS Starter
[](https://github.com/thisismydesign/nestjs-starter/actions/workflows/ci.yml)
#### NestJS MVC boilerplate for rapid development with battle-tested standards.
[Use this template](https://github.com/thisismydesign/nestjs-starter/generate)
[](https://heroku.com/deploy)
## Stack
It has
- Example REST and GraphQL modules, DB using TypeORM as seen on https://docs.nestjs.com/
- [Next.js](https://nextjs.org/) integration for React on the frontend ([howto article](https://csaba-apagyi.medium.com/nestjs-react-next-js-in-one-mvc-repo-for-rapid-prototyping-faed42a194ca))
- Typed queries & results with GraphQL out of the box ([howto article](https://csaba-apagyi.medium.com/automagically-typed-graphql-queries-and-results-with-apollo-3731bad989aa))
- Authentication via [Passport.js](http://www.passportjs.org/) including Social providers ([howto article](https://medium.com/csaba.apagyi/oauth2-in-nestjs-for-social-login-google-facebook-twitter-etc-8b405d570fd2)), [AWS Cognito](https://aws.amazon.com/cognito/) ([howto article](https://medium.com/csaba.apagyi/cognito-via-oauth2-in-nestjs-outsourcing-authentication-without-vendor-lock-in-ce908518f547)), and JWT strategy for REST and GraphQL
- Docker setup
- Typescript, ESLint
- CI via GitHub Actions
- Running tasks (e.g. DB seeding) via [nestjs-console](https://github.com/Pop-Code/nestjs-console)
- Unit and integration testing via Jest
- Heroku deployment setup
- Google Analytics 4
## Usage
The deployments below are probably in sleep mode and will take a minute to come online when you open them.
### Dev
```sh
cp .env.example .env
docker-compose up
docker-compose exec web yarn lint
docker-compose exec web yarn test
docker-compose exec web yarn test:request
docker-compose exec web yarn build
docker run -it -v $PWD:/e2e -w /e2e --network="host" --entrypoint=cypress cypress/included:12.2.0 run
```
## Functionality
REST endpoint via Nest
- http://localhost:3000/
JWT-protected REST endpoint via Nest
- http://localhost:3000/private
GraphQL playground (`query WhoAmI` is JWT-protected)
- http://localhost:3000/graphql
```qgl
query Public {
things {
id
name
}
users {
id
provider
}
}
# Add Header: { "Authorization": "Bearer " }
query Private {
whoAmI {
id,
provider,
providerId,
username,
name
}
orders {
id
alias
thing {
name
}
}
}
mutation createOrder {
createOrder(alias: "myname", thingName: "this is a thing you can order") {
id
alias
}
}
```
Cognito auth (redirects to hosted Cognito UI)
- http://localhost:3000/auth/cognito
Google auth
- http://localhost:3000/auth/google
Next.js page
- http://localhost:3000/home
JWT-protected Next.js page
- http://localhost:3000/profile
### Useful commands
Nest CLI:
```
docker-compose exec web yarn nest -- --help
```
TypeORM CLI:
```
docker-compose exec web yarn typeorm -- --help
```
## Resources
- https://github.com/jmcdo29/testing-nestjs