INSTALL.md

These install instructions assume a plain Ubuntu 16.04 server installation.

sudo apt install apache2 libapache2-mod-php git php-cli composer nodejs-legacy npm php-curl
sudo chmod 777 /var/www/html
cd /var/www/html
git clone https://github.com/plepe/openstreetbrowser.git
cd openstreetbrowser
npm install
# At 'npm install' ignore the error "Failed at the openstreetbrowser lint
# script 'standard src/*.js'. This just means that there are some errors with
# the coding style, but this is not fatal.
composer install
git submodule init
git submodule update
cp conf.php-dist conf.php
nano conf.php
npm run build
bin/download_dependencies

For improved performance you should also run:

modulekit/build_cache

Browse to http://localhost/openstreetbrowser

Have fun!

Debugging

For debugging you should add the following line to conf.php:

$modulekit_nocache = true;

Also you should run:

npm run watch

This is very similar to npm run build, but watches JavaScript files for changes and will update the dist/openstreetbrowser.js file. Also it will add debugging information to the final JavaScript file.