orchidmap-front/README.md
2020-03-20 17:11:36 +07:00

37 lines
1.4 KiB
Markdown

# Bicycle routes map editor
Bicycle routes app with automatic routes, map screenshots, stickers and other features.
See it in action: [Demo](http://map.vault48.org/)
## Prerequisites
node, ts-node, osrm-server
### Installing
First, download and install the project
```
git clone https://github.com/muerwre/orchidMap.git
cd orchidMap
npm i
```
### Setting up OSRM
Install OSRM server as written here: https://github.com/Project-OSRM/osrm-backend
Specify country and region in osrm/prepare_maps.sh or download .pbf file from https://download.geofabrik.de/ manually.
After starting ./prepare_maps you'll get parsed .osrm files for Open Source Routing Machine server.
Next you need to edit start_server.sh to specify address, port for server and path to parsed files.
After that run start_server.sh in screen or by the way you feel comfortable.
Next edit ```./config/frontend.js``` and specify OSRM url there. By default, OSRM starts at ```https://localhost:5001/```
### Common setup
Look at ```/config/``` folder, there's backend and frontend .example.js files, just rename them to .js only.
### Client
Configs are placed in ```./config/frontend.js```
For development launch ```npm start``` and visit ```http://localhost:8000/```
For production launch ```npm build```, the output will be placed at ```./dist``` folder, you should configure your http server to serve index html from that folder.