Skip to content

Latest commit

 

History

History
60 lines (34 loc) · 2.94 KB

CONTRIBUTING.md

File metadata and controls

60 lines (34 loc) · 2.94 KB
Raw

Contributing to this TransforMap project

These terms are considered as guidelines for the social process framing the development of this project's codebase. If you intend to contribute to this project, reach out to us via a channels suitable to the nature of your contribution.

Use it.

To gain experience with the service use it either via the live instance at https://data.transformap.co/ or by installing it yourself.

Read about it.

If you run into questions or problems while using it, please make yourself first comfortable with the documentation. Another good starting point for developers is the codebase.

Get involved.

Further on you may want to read or report to the issue tracker, which hosts discussions around malfunctions or new features of this software. As we are embracing a community-reviewed developing model, please file code contributions as a pull request to the master branch.

Get in touch!

For more informal requests or general enquiries, the social side channels of this project are a TransforMap Discourse, the #transformaps Matrix channel or Twitter.

Miscellaneous

  • npm test : Use the test suite! after your changes.
  • npm start : (start API), in another terminal: npm run integration If some of the tests timeout on slow machines on the first run, just rerun them - they will be much faster on subsequent runs after everything is in memcache.
  • npm run lint : Before commiting to get warnings about your coding style.
  • npm install if you update to a new version, and it throws an Error like: Cannot find module '$newmodule'

file responsibilities

in the controllers, controller/poi/poi.js handles the whole request life cycle

  1. parse the request
  2. sends the response

lib files (controllers/poi/lib/poi.js) communicates with models and the database

content manipulation should be done in the model

libs call the model, model does content manipulation, returns data to be posted in the db lib takes the data returned by the model and POSTs it into the DB

testing the API functions

add a new POI:

curl http://localhost:5000/place/ -d@test/fixtures/place-new-to-create-for-api.json -H 'content-type: application/json'

read a POI:

curl http://localhost:5000/place/3f99cbbccb02d48b595c369a150027ec

update a POI:

curl -X PUT http://localhost:5000/place/3f99cbbccb02d48b595c369a150027ec -d@test/fixtures/place-new-to-create-for-api.json -H 'content-type: application/json'

mark a POI as deleted:

curl -X DELETE http://localhost:5000/place/3f99cbbccb02d48b595c369a150027ec