Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/odisseu93/series-api
This is a simple API created, which lists a certain data set of TV Series or streamings
https://github.com/odisseu93/series-api
back-end backend backend-api express expressjs factory-pattern nodejs open-source tdd typescript
Last synced: about 1 month ago
JSON representation
This is a simple API created, which lists a certain data set of TV Series or streamings
- Host: GitHub
- URL: https://github.com/odisseu93/series-api
- Owner: Odisseu93
- License: mit
- Created: 2023-11-12T15:13:17.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-10T13:19:13.000Z (about 1 year ago)
- Last Synced: 2023-12-10T14:25:47.892Z (about 1 year ago)
- Topics: back-end, backend, backend-api, express, expressjs, factory-pattern, nodejs, open-source, tdd, typescript
- Language: TypeScript
- Homepage: https://series-api-eta.vercel.app/
- Size: 279 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Series Api
This is a simple API created, which lists a certain data set of TV Series or streamings
## Goal
Study about creating an API (following the [REST API](https://en.wikipedia.org/wiki/REST)), using [Node.js](https://nodejs.org/en), [Express.js](https://expressjs.com/) and [TypeScript](https://www.typescriptlang.org/)
## Tech Stack
- [Express.js](https://expressjs.com/)
- [Node.js](https://nodejs.org/en)
- [TypesSript](https://www.typescriptlang.org/)
- [Openai API](https://openai.com/)
## Information
To build this API, mocked data was used, this data was obtained through web scrapping carried out on the website [IMDB](https://www.imdb.com/), the algorithm that was used to obtain this data is documented in this [gist](https://gist.github.com/Odisseu93/8720d1509fbe498225e7634e728677e6)
## Swagger
[link](https://app.swaggerhub.com/apis/ULISSESSUPORTETI01/series-api/1.0.0)
## Run locally
1. Clone the project
```bash
git clone https://github.com/Odisseu93/series-api.git
```
2. Go to the project folder
```bash
cd series-api
```
3. Install all dependencies
```bash
yarn install
```
4. Run the server
```bash
para tests `yarn test` e para o build `yarn build`
```
## To contribute
To contribute, first open an [issue](https://github.com/Odisseu93/series-api/issues), saying what will be modified.
## LICENSE
[MIT](LICENSE.md)
## Developer
