Skip to content
This repository was archived by the owner on May 12, 2020. It is now read-only.

Latest commit

 

History

History
55 lines (39 loc) · 2.83 KB

README.md

File metadata and controls

55 lines (39 loc) · 2.83 KB

Staart API

⚠️ This repository contains a development version of Staart API written using NestJS. This is unsupported, incomplete, and should only be used on your own risk. Visit stable repository →

Status
Build GitHub Actions Travis CI Circle CI Azure Pipelines
Dependencies Dependencies Dev dependencies Vulnerabilities FOSSA Status
Community Codacy grade Code maintainability Contributors GitHub Type definitions

Development features

  • OpenAPI JSON endpoint and Swagger UI
  • TypeORM as database driver wirh ORM
  • CRUD filtering, pagination, sorting, relations, cache
  • Authentication
    • Check if password has been pwned

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

Pre-production

  • Remove "no-console": false rule from tslint.json
  • Migrate TSLint to ESLint
  • Remove --forceExit flag from Jest test, add afterAll() to close geolocation