cpt-jack-a-castle/rest-api

REST API backend for Reconmap

Reconmap Rest API

The Reconmap API is a RESTful API that allows any of the clients (Web, CLI, Mobile) to manipulate any of the Reconmap's entities: projects, tasks, commands, reports, users, etc. With the API you can extend Reconmap in any way you can imagine.

This is a component of many in the Reconmap's architecture.

Runtime requirements

• Docker
• Docker compose
• Make

Documentation

The API specs have been documented using the OpenAPI specification. You can use the interactive OpenAPI UI to play with it.

Build instructions

The first thing you need to do is build the containers and prepare the app. This can be achieved by invoking the default make target:

make

Once the containers are built, and the app prepared, you can run the docker services with the following command:

make start

If everything went ok you should be able to use curl or any other HTTP client (eg your browser) to call the API:

curl http://localhost:5510

How to contribute

We are glad you are thinking about contributing to this project. All help is hugely appreciated.

Before you jump to make any changes make sure you have read the contributing guidelines. This would save us all time. Thanks!

How to report bugs or feature requests

If you have bugs or feature requests to report please use the issues tab on Github.

If you want to chat to somebody on the development team head to our Gitter community.