Skip to content

Latest commit

 

History

History

ui

README.md

OSMT UI

This project was generated with Angular CLI. Rather than installing Angular's CLI globally, you can invoke commands on OSMT's ng devDependency by calling npm run ng whatever_command. This may help avoid conflicts with other Angular tooling installed on your development machine.

Development server

OSMT's' UI is built in the resources directory of the API module (api/src/main/resources/ui -- this directory is gitignored). When you start the Spring app, the Spring jar already contains the UI files, and the UI is available via 8080. If the API is running, the UI is already in that jar. Everything works on the same host / port / server via Spring.

When doing UI development, we need the OAuth2 redirect to come back to the Angular/webpack server on 4200. To support this for local UI development, uncomment the line with OSMT_FRONT_END_PORT in your api/osmt-dev-stack.env file. You can then proceed with typical Angular development workflows.

Run npm run ng serve for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

Code scaffolding

Run npm 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 npm run ng build to build the project. The build artifacts will be stored in the dist/ directory. Use the --prod flag for a production build.

Running unit tests

Run npm run ng test to execute the unit tests via Karma. Use <ctrl + c> to exit.

Whitelabel JSON config

A whitelabel JSON file's URI can be defined in the environment file for deployment. This file is loaded dynamically at runtime and can be replaced without rebuilding with access to the deployed file. The URI can be set for each angular environment by setting environment.whiteLabelConfigUri.
On app launch, the file is downloaded in an api call and is deserialized into the AppConfig property AppConfig.settings which is available globally.

How to update the shape of the config

If any changes to the signatures need to be made, such as adding new properties, then both the interface and class located in src/app/models/app-config.model.ts must be updated.

  • The interface IAppConfig provides the expected shape of the json files and type safety when parsing config JSON.
  • The class DefaultAppConfig defines our default set of configurations when no overriding URI is provided.

Further help

To get more help on the Angular CLI use ng help or go check out the Angular CLI README.