Skip to content

Latest commit

 

History

History
67 lines (51 loc) · 3.19 KB

README.md

File metadata and controls

67 lines (51 loc) · 3.19 KB

iD-indoor - friendly JavaScript indoor editor for OpenStreetMap

Basics

  • iD-indoor is a JavaScript OpenStreetMap editor.
  • It's based on iD, the simple OpenStreetMap editor.
  • It's intentionally simple. It lets you do the most basic tasks while not breaking other people's data.
  • It's focused on indoor mapping, making contributions easier.
  • 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.

Live instance

Participate!

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:
      • Install Xcode and run xcode-select --install from a command line
    • 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, otherwise npm install may fail to fetch git repositories
        export 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

Installation

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

  1. Create a local git clone of the project, then cd into the project folder
  2. (Windows Only) Run fixWinSymlinks.bat. This script will prompt for Administrator rights. see also: http://stackoverflow.com/questions/5917249/git-symlinks-in-windows
  3. Run npm install
  4. Run make
  5. Start a local web server, e.g. python -m SimpleHTTPServer
  6. Open http://localhost:8000/ in a web browser

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

License

iD-indoor is based on iD, so available under the same license. iD is available under the ISC License. It includes d3.js, which BSD-licensed.

Thank you

iD-indoor couldn't exist without the great work of the iD editor team. Initial development of iD was made possible by a grant of the Knight Foundation.