noms-digital-studio/ndelius-new-tech

Name: ndelius-new-tech

Owner: NOMS Digital Studio

Description: nDelius New Technology

Created: 2017-06-05 15:46:33.0

Updated: 2018-05-24 12:48:38.0

Pushed: 2018-05-24 12:48:41.0

Homepage:

Size: 11671

Language: Java

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

'NDelius New Technology' Web Application

A Play Framework based website, developed in Java 8 with additional Lombok support.

Fully asynchronous and non-blocking from the ground up, with the potential to serve 10,000 concurrent users from a single server.

Building and running

Prerequisites:

• sbt (Scala Build Tool) http://www.scala-sbt.org/release/docs
• Chrome

Build command (includes running unit and integration tests):

• sbt assembly

Running locally: PARAMS_USER_TOKEN_VALID_DURATION=2000d \ STORE_PROVIDER=mongo \ OFFENDER_API_PROVIDER=stub \ APPLICATION_SECRET=mySuperSecretKeyThing \ ELASTIC_SEARCH_HOST=<the hostname of your ES cluster> \ ELASTIC_SEARCH_PORT=443 \ NOMIS_API_BASE_URL=<the URL of the NOMIS system> \ NOMIS_PAYLOAD_TOKEN=<the NOMIS API payload token> \ NOMIS_PRIVATE_KEY=<the NOMIS API private key> \ ANALYTICS_MONGO_CONNECTION=<the URL of you MongoDb instance>/analytics \ sbt -Dlogback.application.level=DEBUG run

Running deployable fat jar (after building):

• APPLICATION_SECRET=abcdefghijk java -jar ndelius2.jar (in the target/scala-2.11 directory)

Configuration parameters can be supplied via environment variables. See application.conf for full list of variables.

e.g.:

• STORE_ALFRESCO_URL=http://alfresco/ sbt run
• STORE_ALFRESCO_URL=http://alfresco/ APPLICATION_SECRET=abcdefghijk java -jar ndelius2.jar

The website endpoint defaults to local port 9000.

Run all tests:

• sbt clean test

Run frontend tests:

• sbt mocha

Circle CI build

Branch build

The build pipeline performs the following steps

• sbt assembly
• deploy to the new tech smoke test environment
• run smoke tests using the tests in Smoke Tests

If changes are required to the Smoke Tests which would break a master build then just branch the Smoke Tests with a branch of the exact name as this branch. CircleCI will attempt to use a matching branch name else will use master

Master build

The build pipeline performs the following steps

• sbt assembly
• deploy to the new tech dev environment
• deploy to the new tech smoke test environment
• run smoke tests using the tests in Smoke Tests

Development notes

The Play Framework provides the Google Guice Dependency Injection framework as standard, and MVC based Webpages are generated via Play Framework Twirl templates.

Building and running with Docker

• Build Docker Image ./buildDocker.sh
• Run Docker Container docker run -d -p 9000:9000 --name ndelius2 -e APPLICATION_SECRET=abcdef ndelius2

Dependencies

• Alfresco
• Delius Offender API
• Elastic Search
• PDF Generator
• MongoDb (for Analytics)
• NOMIS API