fernandohenriques / nestjs-graphql-boilerplate

Dockerized API boilerplate with NestJS and GraphQL.

NestJS GraphQL API Boilerplate

Getting Started

Docker + Make + Node.js + TypeScript + NestJS + TypeORM + TypeGraphQL + Jest + TSLint + EasyGraphQL Tester = ❤️

Requirements

$ Git --version
>= v2.19

$ Docker --version
>= v19.03.5

$ Docker Compose --version
>= v1.24.1

$ Make --version
>= v4.2.1

$ node --version
>= v10.11.0

$ NPM --version
>= v6.4.1

How to run with Docker

From the terminal, enter the folder where you want to keep the project and perform the following steps:

$ git clone https://github.com/fernandohenriques/nestjs-graphql-boilerplate.git
$ cd nestjs-graphql-boilerplate
$ cp .env.sample .env
$ docker-compose up

How to run without Docker

From the terminal, enter the folder where you want to keep the project and perform the following steps:

$ git clone https://github.com/fernandohenriques/nestjs-graphql-boilerplate.git
$ cd nestjs-graphql-boilerplate
$ cp .env.sample .env
$ npm install
$ npm run start:dev

Run tests

$ cd nestjs-graphql-boilerplate
$ cp .env.sample .env
$ make test

Run tests on CI/CD pipeline

$ cd nestjs-graphql-boilerplate
$ make variables=".env.test" test

Static Analysis

$ cd nestjs-graphql-boilerplate
$ npm run lint

Code Coverage

$ cd nestjs-graphql-boilerplate
$ npm run test:cov

Built With

• Docker
• Make
• Node.js
• TypeScript
• NestJS
• Fastify
• TypeORM
• TypeGraphQL
• Jest
• EasyGraphQL Tester
• NPM
• TSLint
• Husky
• Lint Staged

Author

• Fernando Henriques - GitHub