VICE / README.md
README.md
Raw

Vice

This project was generated with Angular CLI version 12.2.12.

Upon cloning

Ensure you have up to date versions of Angular and NodeJS then in both the Server folder and the Client folder run the npm install command

Development server

First, run node index.js (within the server folder) to start the server.

Then run ng serve for a dev server (within the Client folder). Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

Production server

All that needs to be run is the startup.sh script, make sure it has the correct permissions to run. Because the entire project is built this process can take some time, wait until the whole process is done and the server prints that it has started before trying to connect.

Code scaffolding

Run ng generate component component-name to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module.

Build

Run ng build to build the project. The build artifacts will be stored in the dist/ directory.

Running unit tests

Run ng test to execute the unit tests via Karma.

Running end-to-end tests

Run ng e2e to execute the end-to-end tests via a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities.

Further help

To get more help on the Angular CLI use ng help or go check out the Angular CLI Overview and Command Reference page.

Adding users to the portal

To add a user navigate to the ModuleTests/Azure directory and run the command "node index.js". Afterwards select the addUser function by typing "29". Finally follow the prompts to set the user email, password, role, auth level and name. Roles are as follows: 0 = NA, 1 = Manager 2 = FW, 3 = Dev and 4 = Exec. Auth levels are as follows: 0 = None, 1 = Base, 2 = Manager, 3 = Admin. A auth level of 1 should be sufficient for most.