How it works

Getting started and using our product is easy peasy!

How to use

Only three easy steps

Fulfill the prerequisite, install Docker and follow the following steps

Change the configuration file

LocusQ is suitable for a single country-based map server. Multiple countries can be incorporated but it is not recommended. If there is no change in the configuration then the system will be developed based on Luxembourg. Here is the sample of the Configuration File. For the detailed documentation of changing the configuration file according to needs please go to Documentation of Configuration File.

Alternative Text

Pull the Docker

The docker container can be pulled or run directly. To pull
docker pull locusq/locusq:latest
This can be run directly using the command sudo docker run -ti --rm --name locusq -v $(pwd):/data -p 5432:5432 -p 8080:8080 -p 3100:3100 -p 5000:5000 -p 8002:8002 -p 8989:8989 -p 3000:3000 -p 8888:8888 locusq/locusq:latest. But as the image is too large (around 5 GB for download and around 11 GB for docker image on the server) it is recommended to pull the images first. So that it can be used again if any blocker arises.

Alternative Text

Process data using conf.yml file

Now put the conf.yml file in an empty directory and run the following command
docker run -ti --rm --name locusq -v $(pwd):/data -p 5432:5432 -p 8080:8080 -p 3100:3100 -p 5000:5000 -p 8002:8002 -p 8989:8989 -p 300:3000 -p 3708:8888 locusq/locusq:latest
A sudo user might be needed if not running root user. It will take a considerable time to process the data based on country size and osm data volume.
Congratulations!!! All the services are up and ready for you
All the Endpoints can be found here.

Alternative Text