andyklimczak / TheReportOfTheWeek-API

API of The Report Of The Week Reviews

The Report Of The Week API

Basic API to provide information on The Report Of The Week

Example Review

{
    "product": "5 Hour Energy Pomegranate",
    "manufacturer": "Living Essentials",
    "category": "Energy Crisis",
    "videoTitle": "Energy Crisis--Energy Drink Review",
    "videoCode": "wyD3nCv_emI",
    "dateReleased": "2011-02-20T00:00:00.000Z",
    "rating": 7
}

Usage

• Check status:
  • GET /
• All reports (sorted by date):
  • GET /reports
• Reports by category
  • GET /reports?category=Energy Crisis
  • GET /reports?category=Running On Empty
• Reports between certain dates
  • GET /reports?between=2012-1-1|2013-1-1

Example Frontends

• The Report of the Week Client Interactive charts using React, Redux, and Recharts

Development

0. Install mongodb, node, and npm
1. Clone the repo
2. npm install
3. npm start will load the data and start the server
4. npm test will run the tests

Update data

The json information the server returns is created from seeds/reports.json. Information from new videos needs to be entered manually. Please feel free to update/append new data !