More information about the HEC (Hidden Economy Conditionality) project can be found here.
This microservice serves the public digital UI to allow licence applicants to perform a tax check. If successful, applicants will receive a tax check code at the end of the journey that they can give to the relevant licencing bodies (LB's) to allow their licence to be issued.
When running locally, the dependant services can be run using the service manager command
sm2 --start HEC_DEP
All HEC services can run via
sm2 --start HEC_ALL
By default, this service runs on port 10106.
A journey can be started via the start endpoint
GET /tax-check-for-licence/start
This will prompt the user to log in if there isn't an active session yet.
Different journeys can be started via the test-only journey starter page at
GET /tax-check-for-licence/test-only/start-journeys
When a journey is selected and submitted here, the login session is set up in the background with the appropriate test data, thereby bypassing the login step on the UI. To enable the test-only endpoint, start the service with the option
sbt run -Dplay.http.router=testOnlyDoNotUseInAppConf.Routes
The rules defining the route from one page to another are contained in JourneyService. As well as defining the routes
forward, this service also automatically calculates the previous page relative to a current page based upon the session
state. This is used to make the back links on the pages point to the right place.
A distinction is made between "incomplete" user answers and "complete" user answers to represent the answers a user has
given during their journey. This distinction is made to facilitate navigation with the "check your answers" pattern. The
JourneyService is responsible for uplifting "incomplete" answers to "complete" ones if all questions have been
answered.
Test data to use can be found in the stub microservice.
This repository uses Scalafmt, a code formatter for Scala. The formatting rules configured for this repository are defined within .scalafmt.conf.
To apply formatting to this repository using the configured rules in .scalafmt.conf execute:
sbt scalafmtAll
To check files have been formatted as expected execute:
sbt scalafmtCheckAll scalafmtSbtCheck
Visit the official Scalafmt documentation to view a complete list of tasks which can be run.
This code is open source software licensed under the Apache 2.0 License.