|
1 | | -# angular2-webpack |
| 1 | +# angular-webpack |
2 | 2 |
|
3 | | -[](https://david-dm.org/preboot/angular2-webpack#info=dependencies) [](https://david-dm.org/preboot/angular2-webpack#info=devDependencies) |
4 | | -[](https://gitter.im/preboot/angular2-webpack?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) |
| 3 | +[](https://david-dm.org/preboot/angular-webpack#info=dependencies) [](https://david-dm.org/preboot/angular-webpack#info=devDependencies) |
| 4 | +[](https://gitter.im/preboot/angular-webpack?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) |
5 | 5 |
|
6 | | -A complete, yet simple, starter for Angular 2 using Webpack. |
| 6 | +A complete, yet simple, starter for Angular v2+ using Webpack. |
7 | 7 |
|
8 | | -This seed repo serves as an Angular 2 starter for anyone looking to get up and running with Angular 2 and TypeScript fast. Using [Webpack](http://webpack.github.io/) for building our files and assisting with boilerplate. We're also using Protractor for our end-to-end story and Karma for our unit tests. |
9 | | -* Best practices in file and application organization for [Angular 2](https://angular.io/). |
| 8 | +This seed repo serves as an Angular starter for anyone looking to get up and running with Angular and TypeScript fast. Using [Webpack](http://webpack.github.io/) for building our files and assisting with boilerplate. We're also using Protractor for our end-to-end story and Karma for our unit tests. |
| 9 | +* Best practices in file and application organization for [Angular](https://angular.io/). |
10 | 10 | * Ready to go build system using [Webpack](https://webpack.github.io/docs/) for working with [TypeScript](http://www.typescriptlang.org/). |
11 | | -* Testing Angular 2 code with [Jasmine](http://jasmine.github.io/) and [Karma](http://karma-runner.github.io/). |
| 11 | +* Testing Angular code with [Jasmine](http://jasmine.github.io/) and [Karma](http://karma-runner.github.io/). |
12 | 12 | * Coverage with [Istanbul](https://github.com/gotwarlost/istanbul) |
13 | | -* End-to-end Angular 2 code using [Protractor](https://angular.github.io/protractor/). |
| 13 | +* End-to-end Angular code using [Protractor](https://angular.github.io/protractor/). |
14 | 14 | * Stylesheets with [SASS](http://sass-lang.com/) (not required, it supports regular css too). |
15 | 15 | * Error reported with [TSLint](http://palantir.github.io/tslint/) and [Codelyzer](https://github.com/mgechev/codelyzer). |
16 | 16 | * Documentation with [TypeDoc](http://typedoc.org/). |
17 | 17 |
|
18 | 18 | >Warning: Make sure you're using the latest version of Node.js and NPM |
19 | 19 |
|
20 | | -[Is Angular 2 Ready Yet?](http://splintercode.github.io/is-angular-2-ready/) |
21 | | - |
22 | 20 | ### Quick start |
23 | 21 |
|
24 | | -> Clone/Download the repo then edit `app.ts` inside [`/src/app/app.component.ts`](/src/app/app.component.ts) |
25 | | -
|
26 | 22 | ```bash |
27 | 23 | # clone our repo |
28 | | -$ git clone https://github.com/preboot/angular2-webpack.git my-app |
| 24 | +$ git clone https://github.com/preboot/angular-webpack.git my-app |
29 | 25 |
|
30 | 26 | # change directory to your app |
31 | 27 | $ cd my-app |
@@ -57,7 +53,7 @@ go to [http://localhost:8080](http://localhost:8080) in your browser. |
57 | 53 |
|
58 | 54 | What you need to run this app: |
59 | 55 | * `node` and `npm` (Use [NVM](https://github.com/creationix/nvm)) |
60 | | -* Ensure you're running Node (`v5.x.x`+) and NPM (`3.x.x`+) |
| 56 | +* Ensure you're running Node (`v6.x.x`+) and NPM (`3.x.x`+) |
61 | 57 |
|
62 | 58 | ## Installing |
63 | 59 |
|
@@ -117,19 +113,19 @@ You can generate api docs (using [TypeDoc](http://typedoc.org/)) for your code w |
117 | 113 |
|
118 | 114 | No, Webpack will add all the needed Javascript bundles as script tags and all the CSS files as link tags. The advantage is that you don't need to modify the index.html every time you build your solution to update the hashes. |
119 | 115 |
|
120 | | -#### How to include external angular 2 libraries ? |
| 116 | +#### How to include external angular libraries ? |
121 | 117 |
|
122 | | -It's simple, just install the lib via npm and import it in your code when you need it. Don't forget that you need to configure some external libs in the [bootstrap](https://github.com/preboot/angular2-webpack/blob/master/src/main.ts) of your application. |
| 118 | +It's simple, just install the lib via npm and import it in your code when you need it. Don't forget that you need to configure some external libs in the [bootstrap](https://github.com/preboot/angular-webpack/blob/master/src/main.ts) of your application. |
123 | 119 |
|
124 | 120 | #### How to include external css files such as bootstrap.css ? |
125 | 121 |
|
126 | | -Just install the lib and import the css files in [vendor.ts](https://github.com/preboot/angular2-webpack/blob/master/src/vendor.ts). For example this is how to do it with bootstrap: |
| 122 | +Just install the lib and import the css files in [vendor.ts](https://github.com/preboot/angular-webpack/blob/master/src/vendor.ts). For example this is how to do it with bootstrap: |
127 | 123 |
|
128 | 124 | ```sh |
129 | 125 | npm install bootstrap@next --save |
130 | 126 | ``` |
131 | 127 |
|
132 | | -And in [vendor.ts](https://github.com/preboot/angular2-webpack/blob/master/src/vendor.ts) add the following: |
| 128 | +And in [vendor.ts](https://github.com/preboot/angular-webpack/blob/master/src/vendor.ts) add the following: |
133 | 129 |
|
134 | 130 | ```ts |
135 | 131 | import 'bootstrap/dist/css/bootstrap.css'; |
|
0 commit comments