charliemitchell / fub-test-server Goto Github PK

At the top of the file there should be a short introduction and/ or overview that explains what the service is. This description should match descriptions added for package managers (package.json, etc.)

List any other software that is required for your application

• Node.js (with NPM)
• Redis

Provide code examples and explanations of how to get the service up and running.

• GET -> api/bars : returns a list of bars
• GET -> api/bars/:id : returns a bar by it's ID

Describe and show how to run the tests with code examples.

Let people know how they can dive into the project, include important links to things like issue trackers or irc if applicable.

A short snippet describing the license (MIT, Apache, etc.)