README.md

Angular, ngrx and Angular Material Starter

by @tomastrajan

Table of Content

• Getting Started
• Useful Commands
• Learning Materials
• List of Projects Built Using This Starter
• Features
• Stack
• Code of Conduct
• Contributors Guide
• Changelog

Getting started

git clone https://github.com/tomastrajan/angular-ngrx-material-starter.git new-project
cd new-project
npm install
npm start

Useful Commands

• npm start - starts a dev server and opens browser with running app
• npm run test - runs lint and tests
• npm run watch - runs tests in watch mode
• npm run prod - runs full prod build and serves prod bundle
• npm run prettier - runs prettier to format whole code base (.ts and .scss)
• npm run analyze - runs full prod build and webpack-bundle-analyzer to visualize how much code is shipped (dependencies & application)

Learning Materials

• Demo & Documentation
• Blog post about Best Practices for Angular CLI used in this starter project
• Blog post about Typescript tips for Ngrx reducer code

Theming

• Blog post
• Presentation (Slides)
• Live coding Video Tutorial
• Meetup Presentation & Live coding Video

Features

• custom themes support (3 themes included)
• lazy-loading of feature modules
• lazy reducers
• localStorage ui state persistence
• @ngrx/effects for API requests
• fully responsive design
• angular-material and custom components in SharedModule

Stack

• Angular
• ngrx (or try ngx-model if you prefer less boilerplate)
• Angular Material
• Bootstrap 4 (only reset, utils and grids)

Acknowledgements

Built with and uses Angular CLI