From bff55ef2bfaabb558e35cba6062b7e1c101a1c50 Mon Sep 17 00:00:00 2001 From: Martin Raifer Date: Thu, 29 Sep 2016 10:16:58 +0200 Subject: [PATCH 1/4] update installation instructions and prerequisites --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a55496bb6..ca3b1b63e 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ Come on in, the water's lovely. More help? Ping `jfire` or `bhousel` on ## Prerequisites -* [Node.js](http://nodejs.org/) version 4 or newer +* [Node.js](http://nodejs.org/) version 4 or newer, ([npm](https://www.npmjs.com/package/npm) version 3 or newer) * Command line development tools (`make`, `git`, and a compiler) for your platform * Ubuntu: * `sudo apt-get install build-essential git` @@ -54,7 +54,7 @@ To run the current development version of iD on your own computer: 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 the local web server `npm run-script web` +5. Run `npm start` 6. Open `http://localhost:8080/` in a web browser For guidance on building a packaged version, running tests, and contributing to From 19c3bb25633b74d543deea018ba2515cfd93d71e Mon Sep 17 00:00:00 2001 From: Martin Raifer Date: Thu, 29 Sep 2016 10:42:07 +0200 Subject: [PATCH 2/4] live reloading with live-server doesn't work anymore --- CONTRIBUTING.md | 11 ----------- 1 file changed, 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a2fb26072..7b9bf9272 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -183,17 +183,6 @@ required for this. 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. -## Live reloading - -You can use [live-server](https://www.npmjs.com/package/live-server) *(npm module)* to -reload the browser automatically whenever there is a change in code. - -1. run `npm install -g live-server` -2. run `live-server .` or `live-server dist` - *(You will be automatically redirected to the local server page.)* - -*(Note: Sometimes auto reload might not display correctly and you might need to rebuild iD by running `make`.)* - ## Licensing iD is available under the [ISC License](https://opensource.org/licenses/ISC). From 06b12c98f033cef70fd8dd8253b65b1941724817 Mon Sep 17 00:00:00 2001 From: Martin Raifer Date: Thu, 29 Sep 2016 10:46:00 +0200 Subject: [PATCH 3/4] update build instructions --- CONTRIBUTING.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7b9bf9272..093578807 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -177,8 +177,7 @@ you can install this via homebrew with `brew install phantomjs`. Then: ## Building / Installing -You can build a concatenated and minified version of iD with the command `make`. Node.js is -required for this. +You can build a concatenated and minified version of iD with the command `make && npm run build-min`. 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. From debbe140b280571c29b7596bbc462eb414f931df Mon Sep 17 00:00:00 2001 From: Martin Raifer Date: Fri, 30 Sep 2016 06:50:08 +0200 Subject: [PATCH 4/4] it works with npm v2 again now --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ca3b1b63e..a548c533f 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ Come on in, the water's lovely. More help? Ping `jfire` or `bhousel` on ## Prerequisites -* [Node.js](http://nodejs.org/) version 4 or newer, ([npm](https://www.npmjs.com/package/npm) version 3 or newer) +* [Node.js](http://nodejs.org/) version 4 or newer * Command line development tools (`make`, `git`, and a compiler) for your platform * Ubuntu: * `sudo apt-get install build-essential git`