Who let the dogs out woof, woof, woof, woof, woof

Overview

Who let the dogs out is an REST API that returns soccer matches from supported Leagues.

Supported Leagues

1. Brasileirão Serie A
2. Brasileirão Serie B

Coming soon

3. Brasileirão Serie C
4. Brasileirão Serie D
5. Copa do Brasil
6. Taça Libertadores
7. Copa do Nordeste
8. Copa do Mundo
9. Copa do Sulamericana
10. Champions League

Endpoints

Matches

• GET /api/matches
  Returns the list of matches that will occur in the interval passed in the query params.
  If no query is passed, returns the matches of the actual day.

  • Query Params:
    startDate=[Date] Beginning of the date interval (included).
    endtDate=[Date] End of the date interval (not included).

    Example: /api/matches?startDate=2018-05-12&endDate=2018-12-22

• POST /api/matches
  Updates all Matches collection with scrapped Matches id DB.
  Requires a token to be passed in the request body.

Getting Started

Install yarn:

npm install -g yarn
# you may need sudo for this

Install dependencies:

yarn

Set environment (vars):

get .env file on #dev channel of our slack.

Start server:

# Start server
yarn start

Docker

Using Docker Compose for Development

# service restarts on file change
bash bin/development.sh