-
Notifications
You must be signed in to change notification settings - Fork 0
Boilerplate Features
The boilerplate has a client-side authentication and authorization system. It is built around JWT. It has pages to handle registering, login, forgot password, and activating accounts (from emails sent by the API).
The boilerplate is built around using roles to control authorization. There are four roles:
- User - the default user, and the user type created through registration. Can manage their own account and read content.
- Editor - All of the abilities of a user and can edit content.
- Admin - All of the abilities of an editor and can perform User CRUD for their own tenancy.
- Super Administrator - All of the abilities of an admin and can perform User CRUD for all tenancies.
These roles are checked throughout the application with guards to prevent accidental access for less-elevated users.
As mentioned above, the boilerplate supports multi-tenancy. This feature is unobtrusive if it's not necessary.
Admins have a section of the site they can access where they can perform User CRUD. Super Administrators can also perform CRUD on Agencies (tenancies). Admins can resend activation emails to users who need to activate their accounts.
The boilerplate has a main content (agents here for the sake of example) section that all authenticated roles can access. Users can view the content. Editors can edit the content. Admins can do full CRUD on the content within their own tenancy (agency). Super Administrators can perform CRUD on the content for all tenancies.
There is a section where any logged in user of any role can change their own profile information, and change their own password.
The boilerplate is configured to use Sentry, an error logging service Shift3 uses (and loves). It just needs the Sentry DSN added to the environment variables. It can support different DSNs for different environments. It also keeps track of which environment is being logged, and the client version number.
The boilerplate uses Terraform to facilitate provisioning a sandbox instance on AWS. This cuts down an all day event to a "run the script and wait 30-45 minutes for AWS to set everything up" event.
The boilerplate uses CircleCI for making sure projects can build, pass tests, and pass linting. It can even display the status of the primary branches in the README as badges.
The boilerplate has working unit tests that cover the client business logic. This not only helps ensure code quality, it can serve as a great set of examples when learning how to write unit tests and how to write them in Angular.
This project uses Prettier to enforce code style. It is highly opinionated by design with relatively scant options for customization. The thought process behind it is to ignore personal styling preferences and instead embrace consistency. There are .prettierrc and .prettierignore configuration files to adjust some options. Prettier is also wired up to a pre-commit hook. This DOES slightly slow down git, as it runs the hook on staged files every time git commit is executed.
Prettier can be configured within editors so that it formats files on save, which helps minimize any changes the pre-commit hook would need to make.
The boilerplate is strongly typed throughout. It takes advantage of typing and classes to help manage objects.
The boilerplate was built with performance in mind. It uses lazy loading, OnPush change detection, trackBy in dynamic *ngFor instances, ng-container to reduce hidden elements in the DOM, and more. This is very helpful for the overall user experience, but also with slower devices, and older browsers.
The application structure was designed around being able to scale to large and complicated use cases.
The boilerplate was built with accessibility as a priority. It supports keyboard navigation, and focus management. It uses semantic HTML and alt/ARIA text for screen readers. The built-in dynamic form helps provide naming and labelling to form fields as well.
The boilerplate uses webpack aliases to help create shorter relative file paths. This makes it easier to refactor and manage project files.