staart / api-nest

๐Ÿโš ๏ธ DEPRECATED: Working repo for NestJS Staart API

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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

About

๐Ÿโš ๏ธ DEPRECATED: Working repo for NestJS Staart API

License:MIT License


Languages

Language:TypeScript 99.0%Language:Dockerfile 1.0%