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: 4 months ago
JSON representation
Boilerplate project for awesome typescript-rest(https://github.com/thiagobustamante/typescript-rest) library
- Host: GitHub
- URL: https://github.com/vrudikov/typescript-rest-boilerplate
- Owner: vrudikov
- License: mit
- Created: 2017-06-12T09:27:34.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-12-27T09:00:19.000Z (almost 6 years ago)
- Last Synced: 2024-08-09T13:17:55.361Z (about 1 year ago)
- Topics: typescript, typescript-rest
- Language: TypeScript
- Homepage:
- Size: 304 KB
- Stars: 81
- Watchers: 6
- Forks: 45
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
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.