docs: add store tutorial example and tweak build to support examples (ngrx#1417)

Author: brandonroberts

Diff for: .circleci/config.yml

@@ -95,7 +95,7 @@ jobs:
           key: *docs_cache_key
       - run: yarn setup 
       - run: npm rebuild node-sass
-      - run: yarn build-for next
+      - run: yarn build-for next && yarn copy-404-page
       - run: cp -rf src/extra-files/next/. dist/ngrx.io/
       # Store artifacts from build
       - persist_to_workspace:

Diff for: .prettierignore

@@ -2,6 +2,7 @@
 /modules/schematics/src/*/files/*
 /modules/**/schematics/**/files/*
 /tmp
+/projects/ngrx.io
 package-lock.json
 package.json
 yarn.lock

Diff for: projects/ngrx.io/.gitignore

@@ -40,6 +40,7 @@ yarn-error.log
 /e2e/*.js
 /e2e/*.map
 protractor-results*.txt
+!e2e/protractor.conf.js
 
 # System Files
 .DS_Store

Diff for: projects/ngrx.io/angular.json

@@ -5,7 +5,7 @@
   "cli": {
     "packageManager": "yarn"
   },
-  "newProjectRoot": "projects",
+  "newProjectRoot": "content/examples",
   "projects": {
     "site": {
       "root": "",

Diff for: projects/ngrx.io/content/examples/store/e2e/src/app.e2e-spec.ts

@@ -0,0 +1,14 @@
+import { AppPage } from './app.po';
+
+describe('workspace-project App', () => {
+  let page: AppPage;
+
+  beforeEach(() => {
+    page = new AppPage();
+  });
+
+  it('should display welcome message', () => {
+    page.navigateTo();
+    expect(page.getParagraphText()).toEqual('Welcome to store-tutorial!');
+  });
+});

Diff for: projects/ngrx.io/content/examples/store/example-config.json

@@ -0,0 +1,5 @@
+<h1>NgRx Tutorial</h1>
+
+<!-- #docregion counter -->
+<app-my-counter></app-my-counter>
+<!-- #enddocregion counter -->

Diff for: projects/ngrx.io/content/examples/store/src/app/app.component.css

@@ -0,0 +1,31 @@
+import { TestBed, async } from '@angular/core/testing';
+import { AppComponent } from './app.component';
+
+describe('AppComponent', () => {
+  beforeEach(async(() => {
+    TestBed.configureTestingModule({
+      declarations: [AppComponent],
+    }).compileComponents();
+  }));
+
+  it('should create the app', () => {
+    const fixture = TestBed.createComponent(AppComponent);
+    const app = fixture.debugElement.componentInstance;
+    expect(app).toBeTruthy();
+  });
+
+  it(`should have as title 'store-tutorial'`, () => {
+    const fixture = TestBed.createComponent(AppComponent);
+    const app = fixture.debugElement.componentInstance;
+    expect(app.title).toEqual('store-tutorial');
+  });
+
+  it('should render title in a h1 tag', () => {
+    const fixture = TestBed.createComponent(AppComponent);
+    fixture.detectChanges();
+    const compiled = fixture.debugElement.nativeElement;
+    expect(compiled.querySelector('h1').textContent).toContain(
+      'Welcome to store-tutorial!'
+    );
+  });
+});

Diff for: projects/ngrx.io/content/examples/store/src/app/app.component.html

@@ -0,0 +1,8 @@
+import { Component } from '@angular/core';
+
+@Component({
+  selector: 'app-root',
+  templateUrl: './app.component.html',
+  styleUrls: ['./app.component.css'],
+})
+export class AppComponent {}

Diff for: projects/ngrx.io/content/examples/store/src/app/app.component.spec.ts

@@ -0,0 +1,19 @@
+// #docregion
+import { BrowserModule } from '@angular/platform-browser';
+import { NgModule } from '@angular/core';
+
+import { AppComponent } from './app.component';
+
+import { StoreModule } from '@ngrx/store';
+import { counterReducer } from './counter.reducer';
+
+@NgModule({
+  declarations: [AppComponent],
+  imports: [
+    BrowserModule,
+    StoreModule.forRoot({ count: counterReducer })
+  ],
+  providers: [],
+  bootstrap: [AppComponent],
+})
+export class AppModule {}

Diff for: projects/ngrx.io/content/examples/store/src/app/app.component.ts

@@ -0,0 +1,22 @@
+// #docregion
+import { BrowserModule } from '@angular/platform-browser';
+import { NgModule } from '@angular/core';
+
+import { AppComponent } from './app.component';
+
+// #docregion imports
+import { StoreModule } from '@ngrx/store';
+import { counterReducer } from './counter.reducer';
+// #enddocregion imports
+import { MyCounterComponent } from './my-counter/my-counter.component';
+
+@NgModule({
+  declarations: [AppComponent, MyCounterComponent],
+  imports: [
+    BrowserModule,
+    StoreModule.forRoot({ count: counterReducer })
+  ],
+  providers: [],
+  bootstrap: [AppComponent],
+})
+export class AppModule {}

Diff for: projects/ngrx.io/content/examples/store/src/app/app.module.1.ts

@@ -0,0 +1,20 @@
+// #docregion
+import { Action } from '@ngrx/store';
+
+export enum ActionTypes {
+  Increment = '[Counter Component] Increment',
+  Decrement = '[Counter Component] Decrement',
+  Reset = '[Counter Component] Reset',
+}
+
+export class Increment implements Action {
+  readonly type = ActionTypes.Increment;
+}
+
+export class Decrement implements Action {
+  readonly type = ActionTypes.Decrement;
+}
+
+export class Reset implements Action {
+  readonly type = ActionTypes.Reset;
+}

Diff for: projects/ngrx.io/content/examples/store/src/app/app.module.ts

@@ -0,0 +1,21 @@
+// #docregion
+import { Action } from '@ngrx/store';
+import { ActionTypes } from './counter.actions';
+
+export const initialState = 0;
+
+export function counterReducer(state = initialState, action: Action) {
+  switch (action.type) {
+    case ActionTypes.Increment:
+      return state + 1;
+
+    case ActionTypes.Decrement:
+      return state - 1;
+
+    case ActionTypes.Reset:
+      return 0;
+
+    default:
+      return state;
+  }
+}

Diff for: projects/ngrx.io/content/examples/store/src/app/counter.actions.ts

@@ -0,0 +1,7 @@
+<button (click)="increment()">Increment</button>
+ 
+<div>Current Count: {{ count$ | async }}</div>
+
+<button (click)="decrement()">Decrement</button>
+
+<button (click)="reset()">Reset Counter</button>

Diff for: projects/ngrx.io/content/examples/store/src/app/counter.reducer.ts

@@ -0,0 +1,24 @@
+import { async, ComponentFixture, TestBed } from '@angular/core/testing';
+
+import { MyCounterComponent } from './my-counter.component';
+
+describe('MyCounterComponent', () => {
+  let component: MyCounterComponent;
+  let fixture: ComponentFixture<MyCounterComponent>;
+
+  beforeEach(async(() => {
+    TestBed.configureTestingModule({
+      declarations: [MyCounterComponent],
+    }).compileComponents();
+  }));
+
+  beforeEach(() => {
+    fixture = TestBed.createComponent(MyCounterComponent);
+    component = fixture.componentInstance;
+    fixture.detectChanges();
+  });
+
+  it('should create', () => {
+    expect(component).toBeTruthy();
+  });
+});

Diff for: projects/ngrx.io/content/examples/store/src/app/my-counter/my-counter.component.css

@@ -0,0 +1,29 @@
+import { Component } from '@angular/core';
+import { Store, select } from '@ngrx/store';
+import { Observable } from 'rxjs';
+import { Increment, Decrement, Reset } from '../counter.actions';
+
+@Component({
+  selector: 'app-my-counter',
+  templateUrl: './my-counter.component.html',
+  styleUrls: ['./my-counter.component.css'],
+})
+export class MyCounterComponent {
+  count$: Observable<number>;
+
+  constructor(private store: Store<{ count: number }>) {
+    this.count$ = store.pipe(select('count'));
+  }
+
+  increment() {
+    this.store.dispatch(new Increment());
+  }
+
+  decrement() {
+    this.store.dispatch(new Decrement());
+  }
+
+  reset() {
+    this.store.dispatch(new Reset());
+  }
+}

Diff for: projects/ngrx.io/content/examples/store/src/app/my-counter/my-counter.component.html

@@ -0,0 +1,14 @@
+<!doctype html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <title>NgRx Tutorial</title>
+  <base href="/">
+
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <link rel="icon" type="image/x-icon" href="favicon.ico">
+</head>
+<body>
+  <app-root></app-root>
+</body>
+</html>

Diff for: projects/ngrx.io/content/examples/store/src/app/my-counter/my-counter.component.spec.ts

@@ -0,0 +1,13 @@
+import { enableProdMode } from '@angular/core';
+import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
+
+import { AppModule } from './app/app.module';
+import { environment } from './environments/environment';
+
+if (environment.production) {
+  enableProdMode();
+}
+
+platformBrowserDynamic()
+  .bootstrapModule(AppModule)
+  .catch(err => console.error(err));

Diff for: projects/ngrx.io/content/examples/store/src/app/my-counter/my-counter.component.ts

@@ -0,0 +1,4 @@
+{
+  "description": "Tutorial",
+  "files": ["!**/*.d.ts", "!**/*.js"]
+}