sabino / xy-inc

A RESTful API in Node.js for managing Points-of-Interest for XY Inc.

XY Inc GPS System

A RESTful API for managing Points-of-Interest for XY Inc.

See the API's documentation.

Commands

npm test # test using Jest
npm run test:unit # run unit tests
npm run test:integration # run integration tests
npm run coverage # test and open the coverage report in the browser
npm run lint # lint using ESLint
npm run dev # run the API in development mode
npm run prod # run the API in production mode
npm run docs # generate API docs

Playing locally

First, you will need to install and run MongoDB in another terminal instance.

$ mongod

Then, run the server in development mode.

$ npm run dev
Express server listening on http://0.0.0.0:9000, in development mode

To create a new POI.

curl -X POST http://0.0.0.0:9000/poi -i -d "name=Lanchonete&x=10&y=20"

It will return something like:

HTTP/1.1 201 Created
...
{
  "id": "47d21fbfbgfa1a6c2347a5d9",
  "name": "Lanchonete",
  "x": 10,
  "y": 20,
  "createdAt": "2016-09-13T15:22:39.846Z",
  "updatedAt":"2016-09-13T15:22:39.846Z"
}