OpenStreetMap
iD - friendly JavaScript editor forBasics
- 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!
- 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: http://preview.ideditor.com/release - Development mirror of
master
branch + latest translations: http://preview.ideditor.com/master
- Stable mirror of
Come on in, the water's lovely. More help? Ping bhousel
on:
- OpenStreetMap US Slack
(
#dev
or#general
channels) - OpenStreetMap IRC
(
irc.oftc.net
, in#osm-dev
or#osm
) - OpenStreetMap
dev
mailing list
Prerequisites
- Node.js version 6 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
- Edit
- Note for Windows users:
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. 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
cd
into the newly cloned project folder- Run
npm install
- Run
npm run all
- Run
npm start
- 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.
Thank you
Initial development of iD was made possible by a grant of the Knight Foundation.