reputation-api/README.md

82 lines
3.4 KiB
Markdown
Raw Normal View History

2023-06-20 15:52:43 -05:00
<p align="center">
<a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="200" alt="Nest Logo" /></a>
</p>
[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
[circleci-url]: https://circleci.com/gh/nestjs/nest
<p align="center">A progressive <a href="http://nodejs.org" target="_blank">Node.js</a> framework for building efficient and scalable server-side applications.</p>
<p align="center">
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a>
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a>
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/dm/@nestjs/common.svg" alt="NPM Downloads" /></a>
<a href="https://circleci.com/gh/nestjs/nest" target="_blank"><img src="https://img.shields.io/circleci/build/github/nestjs/nest/master" alt="CircleCI" /></a>
<a href="https://coveralls.io/github/nestjs/nest?branch=master" target="_blank"><img src="https://coveralls.io/repos/github/nestjs/nest/badge.svg?branch=master#9" alt="Coverage" /></a>
<a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a>
<a href="https://opencollective.com/nest#backer" target="_blank"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a>
<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a>
<a href="https://paypal.me/kamilmysliwiec" target="_blank"><img src="https://img.shields.io/badge/Donate-PayPal-ff3f59.svg"/></a>
<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg" alt="Support us"></a>
<a href="https://twitter.com/nestframework" target="_blank"><img src="https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow"></a>
</p>
<!--[![Backers on Open Collective](https://opencollective.com/nest/backers/badge.svg)](https://opencollective.com/nest#backer)
[![Sponsors on Open Collective](https://opencollective.com/nest/sponsors/badge.svg)](https://opencollective.com/nest#sponsor)-->
2023-06-15 15:37:20 -05:00
2023-06-20 15:52:43 -05:00
## Description
2023-06-15 15:37:20 -05:00
2023-06-20 15:52:43 -05:00
[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
2023-06-15 15:37:20 -05:00
2023-06-20 15:52:43 -05:00
## Installation
2023-06-15 15:37:20 -05:00
2023-06-22 18:11:55 -05:00
First make sure you are using the correct version of `node`
```bash
nvm install
```
Then install the project
2023-06-20 15:52:43 -05:00
```bash
2023-06-22 18:11:55 -05:00
npm install
2023-06-15 15:37:20 -05:00
```
2023-06-20 15:52:43 -05:00
## Running the app
2023-06-15 15:37:20 -05:00
2023-06-20 15:52:43 -05:00
```bash
# development
$ npm run start
2023-06-15 15:37:20 -05:00
2023-06-20 15:52:43 -05:00
# watch mode
$ npm run start:dev
2023-06-15 15:37:20 -05:00
2023-06-20 15:52:43 -05:00
# production mode
$ npm run start:prod
```
2023-06-15 15:37:20 -05:00
2023-06-20 15:52:43 -05:00
## Test
2023-06-15 15:37:20 -05:00
2023-06-20 15:52:43 -05:00
```bash
# unit tests
$ npm run test
2023-06-15 15:37:20 -05:00
2023-06-20 15:52:43 -05:00
# e2e tests
$ npm run test:e2e
2023-06-15 15:37:20 -05:00
2023-06-20 15:52:43 -05:00
# test coverage
$ npm run test:cov
```
2023-06-15 15:37:20 -05:00
## Support
2023-06-20 15:52:43 -05:00
Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).
2023-06-15 15:37:20 -05:00
2023-06-20 15:52:43 -05:00
## Stay in touch
2023-06-15 15:37:20 -05:00
2023-06-20 15:52:43 -05:00
- Author - [Kamil Myśliwiec](https://kamilmysliwiec.com)
- Website - [https://nestjs.com](https://nestjs.com/)
- Twitter - [@nestframework](https://twitter.com/nestframework)
2023-06-15 15:37:20 -05:00
## License
2023-06-20 15:52:43 -05:00
Nest is [MIT licensed](LICENSE).