otwm/nestjs-starter

NestJS MVC boilerplate for rapid development with battle-tested standards.

NestJS Starter

NestJS MVC boilerplate for rapid development with battle-tested standards.

Use this template

Stack

It has

• Example REST and GraphQL modules, DB using TypeORM as seen on https://docs.nestjs.com/
• Next.js integration for React on the frontend (howto article)
• Typed queries & results with GraphQL out of the box (howto article)
• Authentication via Passport.js including Social providers (howto article), AWS Cognito (howto article), and JWT strategy for REST and GraphQL
• Docker setup
• Typescript, ESLint
• CI via GitHub Actions
• Running tasks (e.g. DB seeding) via nestjs-console
• Unit and integration testing via Jest
• Heroku deployment setup
• Google Analytics 4

Usage

Production

https://nestjs-starter-production.herokuapp.com/

Staging

https://nestjs-starter-staging.herokuapp.com/

Dev

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 --entrypoint=cypress cypress/included:10.0.3 run --config-file cypress.docker.config.ts

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

query Public {
  things {
    id
    name
  }

  users {
    id
    provider
  }
}

# Add Header: { "Authorization": "Bearer <token>" }
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