README.md

Description

Musuem Visitors API written with the help of InversifyJS and inversify-express-utils library.

Installation

$ npm install

Running the app

# development
$ npm run dev

# build
$ npm run build

Test

Test written in Mocha, Chai and Sinon. Coverage is done using Istanbul.

# run test and coverage
$ npm run test

API

# API URL
- GET /api/visitors?date=dateInMilliseconds&ignore=museumToIgnore

# API params
- date in millseconds
- museum to ignore (optional)

# API response format
{
    "attendance": {
        “month”: string,
        “year”: number,
        “highest”: {
            “museum”: string,
            “visitors”: number
        },
        “lowest”: {
            “museum”: string,
            “visitors”: number
        },
        “ignored”: {
            “museum”: string,
            “visitors”: number
        },
       “total”: number
    }
}