Skip to content

Latest commit

 

History

History
60 lines (39 loc) · 2.47 KB

README.md

File metadata and controls

60 lines (39 loc) · 2.47 KB

Users Role Nx

CI

This is a frontend application that provides a template for users authentication and authorization since these are common features used in most applications. It also has additional features such as theme selection, snackbar service, alerts service, and a general site layout with header, collapsable sidebar/navigation, and main content area. This application is also a Progressive Web App (PWA) and can be downloaded as an app on mobile and desktop devices.

The authentication is provided by Firebase with Google Identity Platform and the authorization is built off of a node server that makes use of Firebase functions. The production server and all deployments are hosted with Firebase hosting.

The main CI/CD tools used within this project include GitHub Actions and NX Cloud with NX Caching.

Start the app

To start the development server run nx serve usersrole-nx. Open your browser and navigate to http://localhost:4200/. Happy coding!

Testing

Running lint test

Run nx lint <project> or nx run-many -t lint to execute the lint testing via ESLint

Running unit tests

Run nx test <project> or nx run-many -t test to execute the unit tests via Jest.

Running component tests

Run nx component-test <project> --watch or nx run-many -t component-test --watch to execute component tests in watch mode.
Run nx component-test <project> or nx run-many -t component-test to execute component tests in headless mode.
The component tests are making use of a testing framework called Cypress.

Running end-to-end tests

Run nx e2e <project> --watch or nx run-many -t e2e --watch to execute e2e tests in watch mode.
Run nx e2e <project> or nx run-many -t e2e to execute e2e tests in headless mode.
The e2e tests are making use of a testing framework called Cypress.
** Note e2e testing is not performed currently in CI

Deployment

Run nx deploy <project> to execute deploy target.
** This is done manually and is not automated with CD.

Project Info

Production URL: https://users-role-nx.web.app/
Based on: https://github.com/jdwillmsen/usersrole

Developers

  • Jake Willmsen