noms-digital-studio/iis

Name: iis

Owner: NOMS Digital Studio

Description: Historical Prisoners Application UI

Created: 2017-01-19 07:48:53.0

Updated: 2017-08-14 08:52:28.0

Pushed: 2018-01-02 10:22:42.0

Homepage:

Size: 2138

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

Historical Prisoner Application UI.

Get Started

1. Install the dependencies required to run the service:

   m install
   

2. Supply environment variables. The required environment variables are defined in server/config.js.

3. Start the server

   m start
   

   Or, for development, run inspections, tests, watch for changes and start the server:

   lp dev
   

4. Visit localhost:3000

Developer Commands

• gulp lint -> style checks using eslint

• gulp test -> runs all unit tests (Note that tests run with authentication disabled and sending logs to file in iis-ui.log)

• gulp clean -> cleans previously generated files

• gulp build -> cleans and regenerates assets. This is also the default gulp task

  Gulp tasks are defined in individual files under/gulp. Coordinating tasks such as dev, test etc are defined in /gulp/tasks.js

SSO

There are two options for authentication:

• Run the IIS Mock SSO (available in GitHub) - user is automatically logged in via mock SSO

• Set the environment variables listed below to direct SSO requests to an instance of MoJ SSO

Environment variables

The following environment variables are used and values should be supplied for correct operation but have defaults.

• DB_USER - username for DB access
• DB_PASS - password for DB access
• DB_SERVER - DB server host
• DB_NAME - DB name
• CLIENT_ID - SSO Client ID
• CLIENT_SECRET - SSO Client secret
• TOKEN_HOST - SSO server host
• AUTHORIZE_PATH - SSO authorization endpoint, usually /oauth/authorize
• TOKEN_PATH - SSO token endpoint, usually /oauth/token
• USER_DETAILS_PATH - SSO user details endpoint, usually /api/user_details
• HEALTHCHECK_INTERVAL - how often to run the passive healthcheck and output to logs, in minutes
• APPINSIGHTS_INSTRUMENTATIONKEY - Key for Azure application inisghts logger
• APP_BASE_URL - Points to healthcheck endpoint?
• COMPARISON_ENABLED - set to false to disable the comparison feature
• ADDRESS_SEARCH_ENABLED - set to false to disable the address search feature

The following environment variables are used and a value MUST be supplied in production.

• SESSION_SECRET - Secure session configuration