Skip to content

Commit

Permalink
Added scripts in package.json to fix installation (#411)
Browse files Browse the repository at this point in the history
* Added scripts in package.json to fix installation

* Update setup script

* Update README.md

Add installation instructions for windows

* Update README.md

added headers for windows and Unix
  • Loading branch information
aashna27 authored and jywarren committed Oct 22, 2018
1 parent 3df5ca3 commit 965399a
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 3 deletions.
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,20 @@ A diagram of this running 5 steps on a single sample image may help explain how

## Installation

This library works in the browser, in Node, and on the commandline (CLI), which we think is great. You can start a local environement to test the UI with `npm start`
On Unix based environments the command should be run as root user using `sudo npm start` and on windows the command should be run as administrator.
This library works in the browser, in Node, and on the commandline (CLI), which we think is great.

### Unix based platforms
You can setup a local environement to test the UI with `sudo npm setup` followed by `npm start`

### Windows
Our npm scripts do not support windows shells, please run the following snippet in powershell.
```powershell
npm i ; npm i -g grunt grunt-cli ; grunt serve
```
In case of a port conflict please run the folowing
```powershell
npm i -g http-server ; http-server -p 3000
```

### Browser

Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
"scripts": {
"debug": "TEST=true node ./index.js -i ./examples/images/monarch.png -s invert",
"test": "TEST=true tape test/**/*.js test/*.js | tap-spec; browserify test/modules/image-sequencer.js test/modules/chain.js test/modules/meta-modules.js test/modules/replace.js test/modules/import-export.js test/modules/run.js test/modules/dynamic-imports.js | tape-run --render=\"tap-spec\"",
"start": "npm i\nnpm i -g grunt grunt-cli\ngrunt serve"
"setup": "npm i && npm i -g grunt grunt-cli",
"start": "grunt serve"
},
"repository": {
"type": "git",
Expand Down

0 comments on commit 965399a

Please sign in to comment.