yassineaboukir / api-backend

REST API backend for Reconmap

Reconmap

Project planning, implementation and documentation for security professionals and teams. From reconnaissance to intelligence gathering step by step.

Demo

A running demo is available for you to try here: https://demo.reconmap.org

User: admin Password: admin123

Requirements

• Docker
• Docker compose
• Make

Documentation

The API specs have been documented using OpenAPI. You can use the interactive Swagger 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:8080

Alternatively, you could run the Reconmap frontend against your local API with the following commands:

$ cat <<EOF > environment.js
window.env = {
	// URL to the Reconmap API including protocol and port but not trailing slash
    REACT_APP_API_ENDPOINT: 'http://localhost:8080',

	// URL to the Reconmap WebSocket API including protocol and port but not trailing slash
    REACT_APP_WS_ENDPOINT: 'ws://localhost:8765'
};
EOF
$ docker run --rm -d -p 3001:80 \
	-v "$PWD/environment.js:/usr/share/nginx/html/environment.js" \
	--name reconmap-web-client quay.io/reconmap/web-client:master

Then opening your browser at http://localhost:3001

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.