README.md

Soluvas NestJS TypeScript Starter Kit

Soluvas NestJS TypeScript Starter Kit (Target Platform) is an open source boilerplate API backend using NestJS framework, including Apollo GraphQL Server and MongoDB support.

Tech Stack

• Base framework: NestJS
• Language: TypeScript on Node.js
• Web server framework: Fastify
• GraphQL API Server: Apollo Server + apollo-server-fastify + Relay Connections
• Database: MongoDB + Mongoose + Typegoose + nestjs-typegoose
• Linting: ESLint + Prettier (NestJS stack)
• Unit Test: Jest + Supertest (NestJS stack)
• Model/entity helpers: class-validator

Setup

1. Configure .env using .env.dev as template.
2. Run npm run start:dev
3. Test by opening the GraphQL Playground at http://localhost:3111/graphql

{
  hello
  projects {
    pageInfo { hasNextPage, hasPreviousPage, startCursor, endCursor }
    edges { 
      node {
        id, name, slug
      }
      cursor
    }
    aggregate {
      count
    }    
  }
  project(slug: "quakezone") {name}
}

Installation

$ npm install

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

License

Soluvas NestJS Boilerplate is open source, licensed under Apache License Version 2.0.

Soluvas Open Source Low-Code Application Platform

For more information, check out Soluvas Open Source Low-Code Application Platform.