Skip to content
iD Editor for mapeo-desktop
JavaScript CSS Other
Branch: master
Clone or download
Pull request Compare This branch is 19 commits ahead, 1282 commits behind openstreetmap:master.

README.md

iD - friendly JavaScript editor for OpenStreetMap

Build Status Greenkeeper badge

NOTE: CURRENTLY UP TO DATE WITH 2.15.5 of iD

Fork-specific Details

  • We don't use iD's translation mechanism: you can instead apply "monkey patches" on top of the existing set of translations by creating a file monkey_patches/LANG.json, where LANG is the locale you wish to make modifications to. Be sure to run npm run build before publishing a new version of this module to have the modifications be included.

Basics

  • iD is a JavaScript OpenStreetMap editor.
  • It's intentionally simple. It lets you do the most basic tasks while not breaking other people's data.
  • It supports all popular modern desktop browsers: Chrome, Firefox, Safari, Opera, Edge, and IE11.
  • iD is not yet designed for mobile browsers, but this is something we hope to add!
  • Data is rendered with d3.js.

Participate!

Come on in, the water's lovely. More help? Ping bhousel or quincylvania on:

Prerequisites

  • Node.js version 8 or newer
  • git for your platform
    • Note for Windows users:
      • Edit $HOME\.gitconfig:
        Add these lines to avoid checking in files with CRLF newlines
        [core]
        autocrlf = input

Installation

Note: Windows users should run these steps in a shell started with "Run as administrator". This is only necessary the first time so that the build process can create symbolic links.

To run the current development version of iD on your own computer:

Cloning the repository

The repository is reasonably large, and it's unlikely that you need the full history (~200 MB). If you are happy to wait for it all to download, run:

git clone https://github.com/openstreetmap/iD.git

To clone only the most recent version, instead use a 'shallow clone':

git clone --depth=1 https://github.com/openstreetmap/iD.git

If you want to add in the full history later on, perhaps to run git blame or git log, run git fetch --depth=1000000

Building iD

  1. cd into the newly cloned project folder
  2. Run npm install
  3. Run npm run all
  4. Run npm start
  5. Open http://localhost:8080/ in a web browser

For guidance on building a packaged version, running tests, and contributing to development, see CONTRIBUTING.md.

License

iD is available under the ISC License. See the LICENSE.md file for more details.

iD also bundles portions of the following open source software.

Thank you

Initial development of iD was made possible by a grant of the Knight Foundation.

You can’t perform that action at this time.