README.md

iD - friendly JavaScript editor for OpenStreetMap

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, and Edge.
• iD is not yet designed for mobile browsers, but this is something we hope to add!
• Data is rendered with d3.js.

Participate!

• Read the project Code of Conduct and remember to be nice to one another.
• Read up on Contributing and the code style of iD.
• See open issues in the issue tracker if you're looking for something to do.
• Translate!
• Test a prerelease version of iD:
  • Stable mirror of release branch: https://ideditor-release.netlify.app
  • Development mirror of develop branch + latest translations: https://ideditor.netlify.app

Come on in, the water's lovely. More help? Ping Martin Raifer/tyr_asd or bhousel on:

• OpenStreetMap US Slack (#id channel)
• OpenStreetMap Discord (#id channel)
• OpenStreetMap IRC (irc.oftc.net, in #osm-dev)
• OpenStreetMap dev mailing list

Prerequisites

• Node.js version 18 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

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://127.0.0.1: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.

• D3.js (BSD-3-Clause)
• CLDR (Unicode Consortium Terms of Use)
• ohm-editor-layer-index (CC-BY-SA 3.0)
• Font Awesome (CC-BY 4.0)
• Maki (CC0 1.0)
• Temaki (CC0 1.0)
• Röntgen icon set (CC-BY 4.0)
• Mapillary JS (MIT)
• iD Tagging Schema (ISC)
• name-suggestion-index (BSD-3-Clause)
• osm-community-index (ISC)

Thank you

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