nemt-portal-api

API to integrate the member application of Q-Rides

Documentation

The documentation for the project structure and definitions are in ./docs/wiki, and the API documentation, written in Swagger/OpenAPI 2.0 YAML format, can be found in ./docs/swagger and visualized and interacted at http://dev.nemt-portal-api/v1/nemt-portal-api/docs/

Running

To execute with Docker on your machine, run make run-loc; for an execution without a container, directly in the OS, run make run-host.

For a deep undestanding of the Makefile instructions, see its documentation.

Creating a new project

For now, you have to execute this in your terminal (replacing nemt-portal-api with your project's name):

git clone --depth 0 git@bitbucket.org:nemt/nemt-portal-api.git nemt-portal-api