Suite Framework Angular Documentation

The Suite Framework for Angular 9+ is composed of several NgModules, which are developed in the context of a Suite Module.

Notice that we use the word Suite Module for server and client side, since they represent the same concept: a composable unit that can be used like a lego piece to compose your application.

The framework will most likely be distributed as a single npm package taking advantage of tree-shaking. Currently, there's no package being generated, and this statement may change then.

Overview

The Suite Framework Angular documentation is organized as follows:

1. Suite Modules: Includes definitions as to what we'll refer as Suite Modules, as well as some important concepts such as the building blocks said modules will be comprised by.
2. Angular Style Guide: Contains some opinionated recommendations to heed when building Angular Suite modules and components, based on the official Angular Style Guide.
3. State management best practices: Best practices, F.A.Q., and everything related to application state management using NGRX.
4. Angular logging guidelines.
5. Suite Schematics: Describe the suite schematics, their parameters and how to use it.
6. Suite modules theming: Define the guidelines to create a suite module with custom themes.
7. Applications theming: Guidelines for colors selections, suite themes mixin implementation and theming services implementation.