Skip to content
This repository was archived by the owner on Jun 7, 2021. It is now read-only.

Commit 02fad78

Browse files
committed
Updated docs
1 parent 9c47d4d commit 02fad78

File tree

3 files changed

+54
-20
lines changed

3 files changed

+54
-20
lines changed

CHANGELOG.MD

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
* 0.1.2
22
* added ng template cache support (see #67)
33
* configured commons module
4+
* enabled HTML5 mode
5+
* support for executing a subset of the unit tests (or a specific one)
6+
* enhanced TSLint configuration
7+
* support for executing unit tests against multiple Web browsers
8+
* centralized reports
49
* 0.1.1
510
* separated base assets and other assets
611
* fixed issues with TS helpers

README.md

Lines changed: 43 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -8,25 +8,34 @@
88
A Webpack Starter kit featuring:
99
* AngularJS (setup, angular-material, router, ...)
1010
* [TypeScript](http://www.typescriptlang.org/)
11+
* the future of JavaScript available now
1112
* [Redux](https://github.com/rackt/redux)
13+
* one-way data flow for shared state management
1214
* [Immutable.js](https://facebook.github.io/immutable-js/)
13-
* [JSData](http://www.js-data.io/)
1415
* [RxJS](https://github.com/Reactive-Extensions/RxJS)
1516
* [Lodash](https://lodash.com/)
16-
* [SASS](http://sass-lang.com/)
1717
* [PostCSS](https://github.com/postcss/postcss)
1818
* [Autoprefixer](https://github.com/postcss/autoprefixer)
1919
* [Karma](http://karma-runner.github.io/)
20+
* unit test runner
2021
* [Protractor](https://angular.github.io/protractor/#/)
22+
* end-to-end test framework/runner
2123
* [Jasmine](http://jasmine.github.io/)
24+
* bdd unit testing library
2225
* [Istanbul](https://gotwarlost.github.io/istanbul/)
26+
* generate code coverage reports
2327
* [TSLint](https://www.npmjs.com/package/tslint)
28+
* check TypeScript code quality/style
2429
* [Typings](https://github.com/typings/typings)
30+
* manage TypeScript type definitions
2531
* [TSDoc](https://www.npmjs.com/package/tsdoc)
32+
* generate API documentation
2633
* [moment](http://momentjs.com/)
2734
* [Sinon.JS](http://sinonjs.org/)
35+
* [SASS](http://sass-lang.com/)
36+
* [JSData](http://www.js-data.io/)
2837

29-
... and a complete build based on Webpack/npm scripts with:
38+
A complete build based on Webpack/npm scripts and tons of features:
3039
* hot module replacement (HMR)
3140
* https://webpack.github.io/docs/hot-module-replacement-with-webpack.html
3241
* https://webpack.github.io/docs/hot-module-replacement.html
@@ -41,6 +50,10 @@ A Webpack Starter kit featuring:
4150
* TS quality/style checks (TSLint)
4251
* TS code documentation generation (TSDoc)
4352
* development and production configurations
53+
* optimizations for production (minification, compression, ...)
54+
* security best practices
55+
* Content Security Policy (CSP)
56+
* ...
4457
* ...
4558

4659
Check out the [change log](CHANGELOG.MD)
@@ -54,29 +67,23 @@ Note that this starter kit is derived from the Angular 2 Starter Kit: https://gi
5467
Check out the issues/labels & milestones to get an idea of what's next. For existing features, refer to the previous section.
5568

5669
## Installation
57-
...
70+
First of all, make sure that you have installed NodeJS & npm: https://nodejs.org/en/.
5871

59-
## Upgrade
60-
Check out the [upgrade](UPGRADE.MD) page
61-
62-
## Frequently Asked Questions (FAQ)
63-
### Proxy
64-
If you are behind a corporate proxy, you should ensure that your configuration allows you to work correctly.
72+
Two approaches:
73+
* clone this repository: `git clone https://github.com/dsebastien/angularjs-webpack-starter.git`
74+
* download a zip: https://github.com/dsebastien/angularjs-webpack-starter/archive/master.zip
6575

66-
First, you should be able to configure the `HTTP_PROXY` and `HTTPS_PROXY` in your environment so that all CLI tools (e.g., git, typings, ...) can go through the proxy.
76+
Now you can download all the necessary dependencies using the setup script: `npm run setup`.
6777

68-
Don't forget to also define the `NO_PROXY` variable to avoid going through the proxy for local resources (e.g., localhost, local domains, etc).
78+
Finally, you can start the development server using `npm start`.
6979

70-
Note that the .typingsrc file is there to avoid issues caused by SSL termination that is often done in corporate environments. Note that the configuration we provide is INSECURE as it just disables certificate checks. Rather, you should adapt the .typingsrc configuration file so that it continues to check the certificate chain but accepts self-signed certificates generated by your company. Refer to the documentation of typings for more details about the possibilities: https://github.com/typings/typings
80+
Check out the scripts section below for more information about the available commands.
7181

72-
If the above does not work in your case, then check to make sure that the user agents are allowed through the proxy. Some corporate environments filter Web access to specific user agents (e.g., IE). The following user agents should be allowed through:
73-
* npm/
74-
* node/
75-
* git/
76-
* typings/
82+
## Upgrade
83+
Check out the [upgrade](UPGRADE.MD) page
7784

78-
## Build tasks
79-
* `npm run setup`: install typings and project dependencies
85+
## Scripts
86+
* `npm run setup`: install required global dependencies and project dependencies
8087
* `npm start`: start the development server
8188
* `npm run start:hmr`: start the development server with Hot Module Replacement enabled
8289
* `npm run build:prod`: build the production version (in /dist)
@@ -106,6 +113,22 @@ If the above does not work in your case, then check to make sure that the user a
106113
* `npm run webdriver:start`: start the Webdriver Manager
107114
* `npm run webdriver:update`: update Webdriver
108115

116+
## Frequently Asked Questions (FAQ)
117+
### Proxy
118+
If you are behind a corporate proxy, you should ensure that your configuration allows you to work correctly.
119+
120+
First, you should be able to configure the `HTTP_PROXY` and `HTTPS_PROXY` in your environment so that all CLI tools (e.g., git, typings, ...) can go through the proxy.
121+
122+
Don't forget to also define the `NO_PROXY` variable to avoid going through the proxy for local resources (e.g., localhost, local domains, etc).
123+
124+
Note that the .typingsrc file is there to avoid issues caused by SSL termination that is often done in corporate environments. Note that the configuration we provide is INSECURE as it just disables certificate checks. Rather, you should adapt the .typingsrc configuration file so that it continues to check the certificate chain but accepts self-signed certificates generated by your company. Refer to the documentation of typings for more details about the possibilities: https://github.com/typings/typings
125+
126+
If the above does not work in your case, then check to make sure that the user agents are allowed through the proxy. Some corporate environments filter Web access to specific user agents (e.g., IE). The following user agents should be allowed through:
127+
* npm/
128+
* node/
129+
* git/
130+
* typings/
131+
109132
## Links
110133
* Code quality rules (tslint)
111134
* Rules: http://palantir.github.io/tslint/rules/

UPGRADE.MD

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# Upgrade guide
22

3+
## From 0.1.1 to 0.1.2
4+
Wait for it...
5+
6+
## From 0.1.0 to 0.1.1
7+
Wait for it...
8+
39
## From 0.1.0 to 0.1.0
410
Wait for it...
511

0 commit comments

Comments
 (0)