mirror of
https://github.com/aleksilassila/reiverr.git
synced 2026-04-18 14:53:18 +02:00
149 lines
5.0 KiB
Markdown
149 lines
5.0 KiB
Markdown
<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>
|
|
<!--[](https://opencollective.com/nest#backer)
|
|
[](https://opencollective.com/nest#sponsor)-->
|
|
|
|
## Description
|
|
|
|
[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
$ npm install
|
|
```
|
|
|
|
## 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
|
|
```
|
|
|
|
## Structure
|
|
|
|
- Routes
|
|
- series -> shows
|
|
|
|
### Users
|
|
|
|
- PUT /users/{id}
|
|
- GET /users
|
|
- GET /users/{id}
|
|
- DELETE /users/{id}
|
|
- POST /users
|
|
|
|
### Users > Library
|
|
|
|
- GET /users/{userId}/library
|
|
- POST /users/{userId}/library/{tmdbId}
|
|
- DELETE /users/{userId}/library/{tmdbId}
|
|
|
|
### Users > PlayState
|
|
|
|
- GET /users/{userId}/playstate/movies/{tmdbId}
|
|
- GET /users/{userId}/playstate/series/{tmdbId}/{season}/{episode}
|
|
- PUT /users/{userId}/playstate/movies/{tmdbId}
|
|
- PUT /users/{userId}/playstate/series/{tmdbId}/{season}/{episode}
|
|
|
|
### TMDB / Metadata
|
|
|
|
- GET /movies/{tmdbId}
|
|
- GET /movies/{tmdbId}/similar
|
|
- GET /movies/{tmdbId}/sources
|
|
- GET /movies/{tmdbId}/sources/{sourceId}
|
|
- GET /movies/{tmdbId}/sources/{sourceId}/stream
|
|
|
|
- GET /series/{tmdbId}
|
|
- (GET /series/{tmdbId}/season/{season})
|
|
- GET /series/{tmdbId}/season/{season}/episode/{episode}
|
|
- GET /series/{tmdbId}/similar
|
|
- GET /people/{tmdbPersonId}
|
|
|
|
### TMDB / Discovery
|
|
|
|
- GET /discover/movies
|
|
- User-specific
|
|
- GET /discover/series
|
|
|
|
- User-specific
|
|
|
|
- (GET /discover/popular)
|
|
- GET /discover/popular/movies
|
|
- GET /discover/popular/series
|
|
- (GET /discover/network/{network})
|
|
- GET /discover/network/{network}/movies
|
|
- GET /discover/network/{network}/series
|
|
- (GET /discover/genre/{genre})
|
|
- GET /discover/genre/{genre}/movies
|
|
- GET /discover/genre/{genre}/series
|
|
|
|
### Sources
|
|
|
|
- GET /sources
|
|
- (GET /sources/{sourceId})
|
|
- GET /sources/{sourceId}/movies
|
|
- if indexable
|
|
- GET /sources/{sourceId}/movies/{tmdbId}
|
|
- GET /sources/{sourceId}/movies/{tmdbId}/stream
|
|
- GET /sources/{sourceId}/series
|
|
- if indexable
|
|
- GET /sources/{sourceId}/series/{tmdbId}
|
|
- GET /sources/{sourceId}/series/{tmdbId}/season/{season}/episode/{episode}/stream
|
|
|
|
## Resources
|
|
|
|
- [REST best practices](https://github.com/saifaustcse/api-best-practices)
|
|
|
|
## Support
|
|
|
|
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).
|
|
|
|
## Stay in touch
|
|
|
|
- Author - [Kamil Myśliwiec](https://kamilmysliwiec.com)
|
|
- Website - [https://nestjs.com](https://nestjs.com/)
|
|
- Twitter - [@nestframework](https://twitter.com/nestframework)
|
|
|
|
## License
|
|
|
|
Nest is [MIT licensed](LICENSE).
|