docs(AngularCLI): Separated docs and added required section about dep…

…endencies (ngrx#128)
mlb6 · Jun 6, 2016 · 5d1d646 · 5d1d646
1 parent bbdbb1e
commit 5d1d646
Show file tree

Hide file tree

Showing 3 changed files with 63 additions and 48 deletions.
diff --git a/README.md b/README.md
@@ -111,4 +111,4 @@ That's it! You are ready to begin taking advantage of reactive routing!
 * [Route and Query Parameters](./docs/overview/params.md)
 * [Guarding Routes](./docs/overview/guards.md)
 * [SystemJS Configuration](./docs/overview/systemjs.md)
-* [Angular CLI Configuration](./docs/overview/systemjs.md#angular-cli-configuration)
+* [Angular CLI Configuration](./docs/overview/angular-cli.md)
diff --git a/docs/overview/angular-cli.md b/docs/overview/angular-cli.md
@@ -0,0 +1,62 @@
+# Angular CLI Configuration
+`Angular-CLI` is a CLI for making Angular 2 applications. In order to integrate `ngrx/router` into a CLI project we must install the ngrx/router and it's dependencies using NPM and edit the CLI project configuration so that the CLI project knows where to look for the ngrx/router.
+
+## Installation
+`npm install @ngrx/router @ngrx/core --save`
+
+## Setup
+The `angular-cli-build.js` and `system-config.ts` files must be updated for the CLI project to know where to find `ngrx/router`.
+
+### angular-cli-build.js
+The `vendorNpmFiles` array in the `angular-cli-build.js` file must be updated to include the ngrx/router and it's dependencies.
+
+```js
+    vendorNpmFiles: [
+      'systemjs/dist/system-polyfills.js',
+      'systemjs/dist/system.src.js',
+      'zone.js/dist/**/*.+(js|js.map)',
+      'es6-shim/es6-shim.js',
+      'reflect-metadata/**/*.+(js|js.map)',
+      'rxjs/**/*.+(js|js.map)',
+      '@angular/**/*.+(js|js.map)',
+
+      /* ngrx/router begin */
+      '@ngrx/**/*.+(js|js.map)',
+      'path-to-regexp/*.+(js|js.map)',
+      'isarray/*.+(js|js.map)',
+      'query-string/*.+(js|js.map)',
+      'strict-uri-encode/*.+(js|js.map)',
+      'object-assign/*.+(js|js.map)'
+      /* ngrx/router end */
+    ]
+```
+
+### system-config.ts
+The `map` and `packages` constants must be updated in the `system-config.ts` file.
+
+```js
+/** Map relative paths to URLs. */
+const map: any = {
+  /* ngrx/router begin */ 
+  '@ngrx': 'vendor/@ngrx',
+  'path-to-regexp": "vendor/path-to-regexp',
+  'isarray': 'vendor/isarray',
+  'query-string': 'vendor/query-string',
+  'strict-uri-encode': 'vendor/strict-uri-encode',
+  'object-assign': 'vendor/object-assign'
+  /* ngrx/router end */ 
+};
+
+/** User packages configuration. */
+const packages: any = {
+  /* ngrx/router begin */ 
+  '@ngrx/core': { main: 'index' },
+  '@ngrx/router': { main: 'index' },
+  'path-to-regexp': { main: 'index' },
+  'isarray': { main: 'index' },
+  'query-string': { main: 'index' },
+  'strict-uri-encode': { main: 'index' },
+  'object-assign': { main: 'index' }
+  /* ngrx/router end */
+};
+```
diff --git a/docs/overview/systemjs.md b/docs/overview/systemjs.md
@@ -60,50 +60,3 @@ System.config({
   }
 });
 ```
-
-# Angular CLI Configuration
-`Angular-CLI` is a cli for making Angular 2 applications. In order to integrate `ngrx/router` into a CLI project, it must be added to the CLI project configuration.
-
-## Setup
-
-The `system-config.ts` and `angular-cli-build.js` files must be updated for `ngrx/router`.
-
-### system-config.ts
-
-The `map` and `packages` sections must be updated in the `system-config.ts` file.
-
-```js
-/** Map relative paths to URLs. */
-const map: any = {
-  '@ngrx': 'vendor/@ngrx',
-  "path-to-regexp": "vendor/path-to-regexp",
-  'isarray': 'vendor/isarray',
-  'query-string': 'vendor/query-string',
-  "strict-uri-encode": "vendor/strict-uri-encode",
-  "object-assign": "vendor/object-assign"
-};
-
-/** User packages configuration. */
-const packages: any = {
-  "@ngrx/core": { main: 'index' },
-  "@ngrx/router": { main: 'index' },
-  "path-to-regexp": { main: 'index' },
-  "isarray": { main: 'index' },
-  "query-string": { main: 'index' },
-  "strict-uri-encode": { main: 'index' },
-  "object-assign": { main: 'index' }
-};
-```
-
-### angular-cli-build.js
-
-The `ngrx` scope and `ngrx/router` dependencies must also be added to the `vendorNpmFiles` section.
-
-```js
-'@ngrx/**/*.+(js|js.map)',
-'path-to-regexp/*.+(js|js.map)',
-'isarray/*.+(js|js.map)',
-'query-string/*.+(js|js.map)',
-'strict-uri-encode/*.+(js|js.map)',
-'object-assign/*.+(js|js.map)'
-```