orchidmap-front/README.md
2019-03-20 14:25:34 +07:00

1.7 KiB

Bicycle routes map editor

Bicycle routes app with automatic routes, map screenshots, stickers and other features.

See it in action: Demo

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.

Backend

Take a look at ./config/backend.js. By default your api server will be spawned at http://localhost:3000/

For development launch npm serve-dev, it will launch dev server, reloading on every code update

For production launch npm serve and make it running in background by any desirable way, such as forever