Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
shancarter committed Apr 6, 2016
1 parent 92a0f10 commit 4aa1462
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 5 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,11 @@ guidelines](CONTRIBUTING).**

## Development

To run the visualization locally, first run `npm install` to install the development dependencies.
Then run `npm run watch` to start a watcher that automatically compiles the typescript files to a bundled js,
whenever they change. Finally, run `npm run serve` which starts an HTTP server serving all files in the `public` folder.
To see the visualization, visit `http://localhost:8080/` on your browser.
To run the visualization locally you just need a server to serve all the files from the `dist` directory. You can run `npm install` then `npm run serve` if you don't have one handy. To see the visualization, visit `http://localhost:8080/` on your browser.

When developing, use `npm run serve-watch`. This will start a static server and also watchers to automatically compile the typescript, html and css files
whenever they change.

To produce a minified javascript file for production, run `npm run build`.

This is not an official Google product.
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@
"watch-js": "watchify playground.ts -p [tsify] -v --debug -o dist/bundle.js",
"build": "npm run prep && npm run build-js && npm run build-css && npm run build-html",
"watch": "npm run prep & npm run watch-js & npm run watch-css & npm run watch-html",
"serve": "http-server dist/ & npm run watch"
"serve": "http-server dist/",
"serve-watch": "http-server dist/ & npm run watch"
},
"devDependencies": {
"typescript": "^1.8.7",
Expand Down

0 comments on commit 4aa1462

Please sign in to comment.