Skip to content

Latest commit

 

History

History
69 lines (44 loc) · 2.09 KB

README.md

File metadata and controls

69 lines (44 loc) · 2.09 KB

Mapeo Desktop

Build Status

An offline map editing application for indigenous territory mapping in remote environments. It uses mapeo-core for offline peer-to-peer synchronization of an OpenStreetMap database, without any server. The map editor is based on iDEditor, a simple and easy to use editor for OpenStreetMap. The app is built with Electron.

This project is considered stable and used by over 150 communities.

screenshot

For a mobile application that is compatible with Mapeo Desktop, see Mapeo Mobile.

Guide

Read the online user guide for information on how to install aerial imagery and tiles, custom configurations, and more.

architecture

Getting Started

To clone and install all dependencies and start a process to re-build the app whenever you change a file:

git clone [email protected]:digidem/mapeo-desktop.git
cd mapeo-desktop
npm install
npm run build:translations
npm run watch

Before proceeding, you will have to wait until some background processes have culminated. You will know this has taken place when you see terminal output indicating that your app (and assets such as translations) have been built.

Then, in another terminal, run the app in development mode:

npm run dev

Running npm run dev will run the background process in an electron window that can be stepped through similarly to the front-end code.

To see log messages in real-time while in debug mode, run tail in another terminal window:

tail -f USERDATA/Mapeo/logs/$DATE.debug.log

Contributing

See docs/CONTRIBUTING.md for more details.

Community

Connect with the Mapeo community for support & to contribute!

License

GPLv3