map-monitor/DEVELOP.md

Develop

This application is based on web technologies, and mainly written in ECMAScript 6 (modern JavaScript). This documentation is for people who want to build by themselves or develop the project.

Dependencies

You need to install the given tools before starting:

• NodeJS (>= 9) - Documentation
• Transifex CLI - Documentation

Run

To run the project locally, you need to first git clone this repository.

Then, install project dependencies using npm install. Now, you can use following commands to work.

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

Translations

Translations of user interface labels are managed using JSON configuration files, automatically generated using i18nline tool. When editing code, launch manually npm run i18n:build to update these configuration files.

To retrieve translated labels from Transifex, run command npm run i18n:pull.

Documentation

Documentation of the source code uses JSDoc syntax. Readable documentation can be generated using npm run doc command, and will be available as an HTML page in doc/ folder.

Configuration

Various components of the editor can be configured for the instance manager. Main files you can edit are :

• public/config.json : various configurations, in particular OAuth tokens and OSM API URL to use
• public/style.mapcss : MapCSS stylesheet for map features
• public/presets/*.xml : JOSM tagging presets for simple creation and editing of features

You can either make temporary changes by editing these files in your build/ folder, or making changes permanent by editing in public/ folder (and rebuild using described procedure above).