---
description: >-
  The dERP Frontend is a web-based user interface that allows users to interact
  with the dERP platform and its components. This user interface is built using
  Angular CLI version 13.3.9.
---

# ReadME

## Development Environment Setup

To set up the development environment for the dERP Frontend, you need to follow these steps:

1. Install NodeJS (currently using version 16.14.2)
2. Run _**npm i**_ to install project dependencies
3. Edit your hosts file to include the following:
   * 127.0.0.1    sandbox.test-portal.com
   * 127.0.0.1    lsi.test-portal.com
4. _**Run npm run dev:lsi**_ to spin up the development server
5. Navigate to [http://lsi.test-portal.com:4200/](http://lsi.test-portal.com:4200/) in your web browser. The application will automatically reload if you change any of the source files.

### Code Formatting

To ensure that the codebase is consistent, it is important to follow a specific code formatting style. The dERP Frontend uses [Prettier](https://prettier.io/) to format code. You can run _**npm run prettier:write**_ to format the codebase repo-wide. Additionally, you can use npm run lint to check for any linting errors.

### Development Resources

To assist in development, the following resources are available:

Material Icons List: [https://www.angularjswiki.com/angular/angular-material-icons-list-mat-icon-list/](https://www.angularjswiki.com/angular/angular-material-icons-list-mat-icon-list/)

This resource provides a list of icons that can be used in the application, along with the corresponding icon key that can be used to include the icon in the application. The format for including an icon is _**\<mat-icon{icon-key}>\<mat-icon>**_.

### Build

To build the project, run _**ng build**_. The build artifacts will be stored in the _**dist/ directory**_.

### Running Tests

To execute unit tests, run _**ng test via Karma**_.

To execute end-to-end tests, run _**ng e2e**_. Note: To use this command, you need to first add a package that implements end-to-end testing capabilities.
