Skip to content

Commit

Permalink
Update README and typings
Browse files Browse the repository at this point in the history
  • Loading branch information
smmorneau committed Jun 24, 2016
1 parent 1018c30 commit c31853c
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 13 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,19 @@

## Installation
* `npm install -g gulp typings`: installs Gulp and Typings globally
* `npm install`: installs node modules locally
(need to run whenever dependencies in package.json change)
* `typings install`: installs type definitions
(need to run whenever typings.json changes)
* `npm install`: installs node modules locally then triggers type definition
installation and builds the app

## Build and Run
### Automatically
1. `gulp`: lints, builds, and restarts web server on changes
* `gulp`: lints, builds, and restarts web server on changes
(Branch changes will cause server to crash; stop and start before doing so)

If no code has changed since your last build, you can just run:

* `gulp serve`: starts web server with a watcher that will recompile any changed files
(will not trigger recompilation on any files changed before task starts)

### Manually
1. `gulp build`: lints, compiles, and compresses static files
2. `npm start`: starts web server on port 8080
Expand All @@ -49,5 +52,4 @@
* `gulp scripts`: lints, compiles, compresses Typescript to JS only
* `gulp lint`: lints Typescript and SCSS files
* `gulp clean`: clears all built files
* `gulp serve`: starts web server with a watcher that will recompile any changed files
(will not trigger recompilation on any files changed before task starts)
* `typings install`: installs type definitions
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
"tsconfig-glob": "0.4.3",
"tslint": "3.10.1",
"typescript": "1.8.10",
"typings": "1.0.2",
"typings": "1.3.0",
"zone.js": "0.6.12"
},
"devDependencies": {
Expand Down
9 changes: 4 additions & 5 deletions typings.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,11 @@
"version": false,
"dependencies": {
"es6-promise": "registry:npm/es6-promise#3.0.0+20160211003958",
"lodash": "registry:npm/lodash#4.0.0+20160416211519",
"moment": "registry:npm/moment#2.10.5+20160211003958"
"lodash": "registry:npm/lodash#4.0.0+20160416211519"
},
"globalDependencies": {
"es6-shim": "registry:dt/es6-shim#0.31.2+20160317120654",
"jasmine": "registry:dt/jasmine#2.2.0+20160505161446",
"jquery": "registry:dt/jquery#1.10.0+20160417213236"
"es6-shim": "registry:dt/es6-shim#0.31.2+20160602141504",
"jasmine": "registry:dt/jasmine#2.2.0+20160621224255",
"jquery": "registry:dt/jquery#1.10.0+20160620094458"
}
}

0 comments on commit c31853c

Please sign in to comment.