/Mock-Premier-League

Build APIs using Redis and MongoDB

Primary LanguageJavaScript

Mock-Premier-League

Travis

Build Status

Coveralls

Coverage Status

Documentation

Docs

Heroku

Heroku Url

Major Technologies and Frameworks Used

  • Node/Express
  • MongoDB
  • Redis for Web Caching
  • Mocha and Chai Library
  • Docker for containerization
  • Linting with ESLint
  • CI with Travis
  • Code Coverage Report with Coveralls
  • Heroku for deployment

Setting Up

  • Clone this repo with git clone https://github.com/Chiazokam/Mock-Premier-League
  • cd into the created folder
  • .env.example contains the data that would be needed in the .env file. Fill up the necessary data
  • Run docker-compose up
  • Check out the documentation linked above for all the existing endpoints.
  • Following the specification on the docs, send requests to endpoints to view the various responses
  • Rate Limiting has been set up to manage requests made to the APIs. Set the maximum number of calls and time interval for calls in the environment variables.