ci: deploy website to GitHub Pages

- Remove Angular application
- Add Docusaurus website
- Configure Docusaurus website
- Add website CI workflow
- Configure GitHub Pages
- Deploy to GitHub Pages when triggered from `main` branch

Author: LayZeeDK

.angulardoc.json

@@ -0,0 +1,71 @@
+name: "NgRx Essentials website"
+
+env:
+  NODE_OPTIONS: --max_old_space_size=6144
+  node-version: 14.x
+  website-package-name: website
+
+on:
+  push:
+    branches:
+      - main
+  pull_request: {}
+
+jobs:
+  build:
+    name: Build website
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ env.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ env.node-version }}
+
+      - name: Variable-Yarn cache directory path
+        id: yarn-cache-dir-path
+        run: echo "::set-output name=dir::$(yarn cache dir)"
+      - name: Cache Yarn cache directory
+        uses: actions/cache@v2
+        with:
+          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
+          key: ${{ runner.os }}-node-${{ env.node-version }}-yarn-${{ hashFiles('yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-node-${{ env.node-version }}
+            ${{ runner.os }}
+      - run: yarn install
+      - name: Build website
+        run: yarn build
+      - name: "Upload website build artifact"
+        uses: actions/upload-artifact@v2
+        with:
+          name: ${{ env.website-package-name }}
+          path: ./build/
+          if-no-files-found: error
+
+  deploy:
+    name: Deploy website to GitHub Pages
+    if: >
+      github.ref == 'refs/heads/main' && (github.event_name ==
+      'workflow_dispatch' || github.event_name == 'push')
+    needs: build
+    runs-on: ubuntu-latest
+
+    env:
+      package-path: ./static-website/
+
+    steps:
+      # necessary for JamesIves/github-pages-deploy-action
+      - uses: actions/checkout@v2
+
+      - uses: actions/download-artifact@v2
+        with:
+          name: ${{ env.website-package-name }}
+          path: ${{ env.package-path }}
+
+      - name: Deploy docs to GitHub Pages
+        uses: JamesIves/github-pages-deploy-action@releases/v4
+        with:
+          branch: gh-pages
+          folder: ${{ env.package-path }}

.github/workflows/website.yml

@@ -1,46 +1,20 @@
-# See http://help.github.com/ignore-files/ for more about ignoring files.
-
-# compiled output
-/dist
-/tmp
-/out-tsc
-# Only exists if Bazel was run
-/bazel-out
-
-# dependencies
+# Dependencies
 /node_modules
 
-# profiling files
-chrome-profiler-events*.json
-speed-measure-plugin*.json
-
-# IDEs and editors
-/.idea
-.project
-.classpath
-.c9/
-*.launch
-.settings/
-*.sublime-workspace
+# Production
+/build
 
-# IDE - VSCode
-.vscode/*
-!.vscode/settings.json
-!.vscode/tasks.json
-!.vscode/launch.json
-!.vscode/extensions.json
-.history/*
+# Generated files
+.docusaurus
+.cache-loader
 
-# misc
-/.sass-cache
-/connect.lock
-/coverage
-/libpeerconnection.log
-npm-debug.log
-yarn-error.log
-testem.log
-/typings
-
-# System Files
+# Misc
 .DS_Store
-Thumbs.db
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

.gitignore

@@ -1,27 +1,33 @@
-# NgrxTutorial
+# Website
 
-This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 8.2.2.
+This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
 
-## Development server
+### Installation
 
-Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
+```
+$ yarn
+```
 
-## Code scaffolding
+### Local Development
 
-Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
+```
+$ yarn start
+```
 
-## Build
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
 
-Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build.
+### Build
 
-## Running unit tests
+```
+$ yarn build
+```
 
-Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
 
-## Running end-to-end tests
+### Deployment
 
-Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).
+```
+$ GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
+```
 
-## Further help
-
-To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md).
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

README.md

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};

angular.json

@@ -1,14 +1,17 @@
-# Chapter 1: Introduction to NgRx
+---
+title: "Chapter 1: Introduction to NgRx"
+sidebar_position: 1
+---
 
 ## Preface
 
-*This tutorial was created and is maintained by Armen Vardanyan, an Angular/NgRx enthusiast just like you. The project is open sourced, read about how you can also contribute to is here*
+_This tutorial was created and is maintained by Armen Vardanyan, an Angular/NgRx enthusiast just like you. The project is open sourced, read about how you can also contribute to is here_
 
 I want to help people master skills necessary for WebDev as quick as possible, so I won't be using big words and long introductions here. Just a few sentences about this tutorial
 
 ### What will you learn?
 
-After you complete this tutorial, you will 
+After you complete this tutorial, you will
 
 1. Know the basic and advanced concepts of NgRx
 2. Be able to create applications using NgRx
@@ -22,9 +25,9 @@ I hold a firm belief that in order to learn and understand something thoroughly,
 
 ### How is this tutorial structured?
 
-The tutorial is divided into simple chapters (you are, as you've noticed, reading Chapter 1 right now). After you finish a chapter, you can move on to the next one. 
+The tutorial is divided into simple chapters (you are, as you've noticed, reading Chapter 1 right now). After you finish a chapter, you can move on to the next one.
 Each chapter explores one single, isolated topic, with small examples, and then puts it into use in the application that we are building.
 
 ### What's next?
 
-Now, that we know what and why we are doing, let's move on to Chapter 2, where we will actually start doing stuff. 
+Now, that we know what and why we are doing, let's move on to Chapter 2, where we will actually start doing stuff.