CalvinBackup/iD
1
0
Fork 0
mirror of https://github.com/FoggedLens/iD.git synced 2026-02-12 16:52:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Docs/CONTRIBUTING: Reference wiki on how to build (#10203)

Browse Source
This commit is contained in:
Tobias
2024-04-24 13:19:51 +02:00
committed by GitHub
parent 5e03b41261
commit ec14161eaa
2 changed files with 2 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
CONTRIBUTING.md
View File

@@ -370,10 +370,7 @@ Note that in order to run the tests, Chrome needs to be installed on the system.
### Building / Installing
You can rebuild iD completely with the command `npm run all`.
iD will be built to the `dist` directory. This directory is self-contained; you can copy it
into the public directory of your webserver to deploy iD.
Follow the steps in the [how to get started guide](https://github.com/openstreetmap/iD/wiki/How-to-get-started#build-and-test-instructions) on how to build and run iD.
### Licensing

40
README.md
View File

@@ -27,47 +27,9 @@ Come on in, the water's lovely. More help? Ping `Martin Raifer`/`tyr_asd` or `bh
* [OpenStreetMap IRC](https://wiki.openstreetmap.org/wiki/IRC) (`irc.oftc.net`, in `#osm-dev`)
* [OpenStreetMap `dev` mailing list](https://wiki.openstreetmap.org/wiki/Mailing_lists)
## Prerequisites
* [Node.js](https://nodejs.org/) version 18 or newer
* [`git`](https://www.atlassian.com/git/tutorials/install-git/) for your platform
* Note for Windows users:
* Edit `$HOME\.gitconfig`:<br/>
Add these lines to avoid checking in files with CRLF newlines<br><pre>
[core]
autocrlf = input</pre>
## 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`
3. Run `npm start`
4. 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](CONTRIBUTING.md).
Follow the steps in the [how to get started guide](https://github.com/openstreetmap/iD/wiki/How-to-get-started#build-and-test-instructions) on how to install, build and run iD locally.
## License