manojattri181 / masai-library

Fake RESTful API

A fake RESTful API for testing purposes, running using the npm module json-server. You can easily deploy the API to services like Heroku by simply pushing the repository there.

Installation

Run npm to install all dependencies:

npm install

Now you are ready to deploy to Heroku:

# Login with your Heroku account
heroku login

# Create the project
heroku create your-api-project-name

# Deploy to Heroku
git push heroku master

Test your API by running:

heroku open

Editing the initial data

The database is in the file db.json. You can edit the JSON information there.

HTTP Requests & Endpoints

Refer to the json-server documentation for how to use your API.