Angular NGRX Quickstart

A simple REST app built using Angular, Angular Material, NGRX, and the Angular CLI via Nrwl.

This app demonstrates how to structure and handle communication between components in an Angular app.

Prerequisites

• Git
• Node.js and NPM – we recommend using NVM (Linux/Mac) or NVM-Windows (Windows)
• Install Angular CLI via npm i -g @angular/cli

Getting Started

There are two main parts to this application. The first is the REST API, for which we are using json-server. The second part is the Angular 2 application server which we will start using ng serve.

To get started run the commands below.

$ git clone https://github.com/onehungrymind/angular-ngrx-quickstart.git
$ cd angular-ngrx-quickstart
$ npm install
$ npm start

Then navigate to http://localhost:4200 in your browser.

Note: the above terminal commands are for Mac. Remember to substitute the appropriate commands for your OS.

Generating Custom Elements

Angular has the ability to turn a component into a standalone custom element and embed that in an HTML document.

Simply run npm run build:elements to generate a standalone element.

This will run an ng build, concatenate the resulting scripts into one file, and copy that file to the site directory.

Once that script is finished, simply serve the site directory.

Code scaffolding

Run ng generate component component-name to generate a new component. You can also use ng generate directive/pipe/service/class.

Build

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.

Running unit tests

Run ng test to execute the unit tests via Karma.

Running end-to-end tests

Run ng e2e to execute the end-to-end tests via Protractor. Before running the tests make sure you are serving the app via ng serve.