An open API service indexing awesome lists of open source software.

https://github.com/tcriss/roadrunners-nest

The RoadRunners API nestJS variant
https://github.com/tcriss/roadrunners-nest

learning-by-doing mongodb nestjs nodejs personal-project

Last synced: 3 months ago
JSON representation

The RoadRunners API nestJS variant

Awesome Lists containing this project

README

        

## RoadRunners-API fork

This is a fork from the original api made by [HaroldMart](https://github.com/HaroldMart/RoadRunners-Backend). I rebuilt the original api in NestJS, taking advantages of its structure & organizations.

## Dependencies

- nestjs/express
- dotenv
- typeOrm
- morgan
- multer
- cors
- passport jwt
- axios
- class-validator
- class-transformer
- cloudinary
- jwks-rsa
- mongodb

## Installation

```bash
$ npm install
```

## Building with docker

```bash
$ docker compose up --build -d
```

## Running the app

```bash
# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod
```

## Test

```bash
# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov
```