Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/goktugcy/onedio-case
https://github.com/goktugcy/onedio-case
Last synced: about 7 hours ago
JSON representation
- Host: GitHub
- URL: https://github.com/goktugcy/onedio-case
- Owner: goktugcy
- Created: 2023-12-23T14:29:33.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2023-12-25T06:16:57.000Z (11 months ago)
- Last Synced: 2024-08-12T23:22:23.549Z (3 months ago)
- Language: TypeScript
- Size: 135 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Onedio Case Project
This project is designed as a part of a case study for Onedio. It includes various components that work together to demonstrate specific functionalities.
## Used technologies
- Express
- TypeScript
- MongoDB
- Redis
- Docker
- Prettierc etc.
## Installation
```bash
cd /onedio-case
env.example change to .env and configure file
npm install
npm run build
run cli command : node dist/src/cli/fetchdata.js
npm run dev
npm run test
project start on local: npm run dev / npm run start
project start on docker: docker-compose up --build
```
## API
#### Example
```
GET /fixtures?league=Bundesliga&season=2018-2019&limit=15&page=1
GET /fixtures?league=Premier League&season=2017-2018&limit=8&page=1
```
| Parametre | Tip | Açıklama |
| :-------- | :------- | :------------------------- |
| `league` | `string` | **Required**. Premier League & Bundesliga. |
| `season` | `string` | **Required**. ex: 2017-2018 |
| `limit` | `integer` | Number of fixtures per page. |
| `page` | `integer` | Page number. |
#### Swagger documentation :
`GET http://0.0.0.0:3001/api-docs/`