As a part of making Hygieia more modular, this repo will host Hygieia UI code. More to come!!!!
This project requires Angular CLI version 8.0.3.
- Fork and clone the UI folder
- Navigate to your UI folder and install the package dependencies by running
npm install - Download Angular CLI by running
npm install -g @angular/cli@8.0.3 - You can run
ng versionto check your Angular CLI version and related package dependency versions (make sure the package versions are v8)
Before you start, you must run the api on the side. After you fork/clone the Hygieia api, navigate to the \api directory and run the following command:
mvn clean install
This will create an output api.jar file in the \target folder.
Tip: Before you continue, make sure you set the configurable parameters in the api.properties file to connect to the dashboard MongoDB database instance, including properties required by the API module. For more information, please visit the Hygieia api guide.
Navigate to api\target, and execute the following command in the command prompt:
java -jar api.jar --spring.config.location=C:\[path to api.properties file] -Djasypt.encryptor.password=hygieiasecret
With the api running, open a different terminal and run ng build in your \UI folder. The build artifacts will be stored in the dist/ directory. Use the --prod flag for a production build.
In the \UI folder, run ng serve for a dev server. Navigate to http://localhost:4200/ in a incognito browser. The app will automatically reload if you change any of the source files.
Run ng test to execute the unit tests via Karma. You can also debug using Karma.
An alternative method to run unit tests is to run npm run test-headless in your UI folder in a terminal. This will also test your code coverage.
If you are using IntelliJ, you can debug with JavaScript Debug. Navigate to the Edit Configurations tab, hit the + sign to Add New Configuration, and add JavaScript Debug.
Inside the Run/Debug Configurations popup, you can edit the name to your preference and change the URL to http://localhost:4200. This will allow you to navigate the UI on localhost to hit the debug breakpoints you set.
Use the Default Chrome browser and apply your changes.
Note: When you start the debug property, it will open a new browser popup for debugging specifically (also in localhost:4200).
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.
Run ng e2e to execute the end-to-end tests via Protractor.
To get more help on the Angular CLI use ng help or go check out the Angular CLI README.