mirror of
https://github.com/FoggedLens/iD.git
synced 2026-05-20 07:25:15 +02:00
Bryan Housel
053074d076
(closes #3324) Previously we allowed devs to swap out services that they didn't need. This became difficult now that ES6 exports are immutable bindings. But we can wrap the immutable bindings themselves in a live object, to get back the flexibility that we used to have. This change also drops the `taginfo` accessor on Context, since devs who want to swap out taginfo service with something else can now do so through the live binding. `iD.services.taginfo = myTaginfo()`
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, 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
releasebranch: http://openstreetmap.us/iD/release - Development mirror of
masterbranch: http://openstreetmap.us/iD/master
- Stable mirror of
Come on in, the water's lovely. More help? Ping jfire or bhousel on
OpenStreetMap IRC
(irc.oftc.net, in #iD or #osm-dev or #osm) or on the OpenStreetMap dev mailing list.
Prerequisites
- Node.js version 4 or newer
- Command line development tools (
make,git, and a compiler) for your platform- Ubuntu:
sudo apt-get install build-essential git
- macOS:
- Run
xcode-select --installfrom a command line or install Xcode
- Run
- Windows (Cygwin):
- Install Git for Windows
- Install Cygwin - choose default packages +
make,wget,apache2(needed for updated mime type list) - Optionally, install apt-cyg for managing your Cygwin packages
- Edit
~/.bashrc:
Put Git for Windows before Cygwin in PATH, otherwisenpm installmay fail to fetch git repositoriesexport PATH=/cygdrive/c/Program\ Files/Git/mingw64/bin/:$PATH
- Edit
~/.gitconfig:
Add these lines to avoid checking in files with CRLF newlines[core] autocrlf = input
- Ubuntu:
Installation
To run the current development version of iD on your own computer:
- Create a local
git cloneof the project, thencdinto the project folder - (Windows Only) Run
fixWinSymlinks.bat. This script will prompt for Administrator rights. see also: http://stackoverflow.com/questions/5917249/git-symlinks-in-windows - Run
npm install - Run
make - 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. It includes d3.js, which BSD-licensed.
Thank you
Initial development of iD was made possible by a grant of the Knight Foundation.