Create API Endpoints

[joshuamabina]

Timelines

• Expected Length to Complete: 1 week
• Due Date: 25th May 2019

Challenge Summary

You are required to create a set of API endpoints already defined below and use data structures to store data in memory (don’t use a database).

Important Note

• You are to create a pull-request to elicit review and feedback when you are done working on this challenge.
• All JavaScript MUST be written in ES6 or higher and should use Babel to transpile down to ES5.
• Classes / modules MUST respect SRP (Single Responsibility Principle) and MUST use the ES6 methods of module imports and exports

Tools

• Server-side Framework: Node / Express

• Linting library: ESLint

• Styleguide: AirBnB

• Testing framework: jest

• Continuous integration: Travis CI

Guidelines

1. On GitHub Projects Board, create user stories to setup and test API endpoints that do the following using data structures

   1. Get all ride offers
   2. Get a specific ride order
   3. Create a ride offer
   4. Make a request to join a ride

2. On GitHub Projects Board, create user stories to capture any other tasks not captured above. The tasks can be a feature, bug or chore for this challenge.

3. Setup the server side of the application using the specified framework

4. Setup linting library and ensure that your work follows the specified style guide requirements.

5. Setup a test framework

6. Version your API using url versioning starting, with the letter “v”. A simple ordinal number would be appropriate and avoid dot notation such as 2.5. An example of this would be: https://www.yourappname.com/api/v1/users

7. Using separate branches for each feature, create version 1 (v1) of your RESTful API to power front-end pages.

8. At minimum, you should have implement API endpoints describe below.

9. Write tests for the API endpoints

10. Ensure to test all endpoints and see that they work with Postman.

11. Integrate Travis CI for Continuous Integration in your repository with readme.md badge.

12. Integrate test coverage reporting (e.g. Coveralls) with badge in the readme.md.

13. Obtain CI badges (e.g. from Code Climate and Coveralls) and add to readme.md.

14. Ensure that app gets hosted on Heroku.