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

https://github.com/vrudikov/typescript-rest-boilerplate

Boilerplate project for awesome typescript-rest(https://github.com/thiagobustamante/typescript-rest) library
https://github.com/vrudikov/typescript-rest-boilerplate

typescript typescript-rest

Last synced: 7 months ago
JSON representation

Boilerplate project for awesome typescript-rest(https://github.com/thiagobustamante/typescript-rest) library

Awesome Lists containing this project

README

        

# Features
- Decorator based API. Throw away your boilerplate code :hooray
- Сluster bootstrap out of the box
- `morgan` for logging
- JWT tokens for security. See [security decorator](https://github.com/thiagobustamante/typescript-rest/wiki/@Security-Decorator)
- MongoDB connector
- TODO: MongoDB examples... in progress

# Initial setup
```
npm install
```

## Swagger Docs Generation

```
npm run swagger
```

# Project run
```
npm start
```

## Start project in cluster
```
npm start:cluster
```

## Docker build and run
```
npm run build
docker-compose up -d
```

## UI Test
Just go to http://127.0.0.1:3000

## Test

```
npm run test
```

### Test with coverage reports:

```
npm run test:coverage
```

The coverage report will be saved under ```./reports/coverage``` folder.