pertax-frontend: A Scala repository from oscarduignan

pertax-frontend

This is the repository for the Personal Tax Account (PTA) frontend project.

Integrating the PTA header into your project

Example Partial URL:

//personal-account/integration/main-content-header? \
  name=John%20Smith& \
  lastLogin=1444229760085& \
  item_text=Home& \
  item_url=%2F& \
  item_text=Profile& \
  item_url=%2Fprofile& \
  showBetaBanner=true

Add in your application.conf like this:

header-service {
  headerPartial = "%s/personal-account/integration/main-content-header"
}

Partial URL parameters:

Parameter	Type	Example	Description
name	string	John Smith	Name of the logged in user
lastLogin	number	1444229760085	Time in milliseconds of last login
item_text	string	Home	Link text for breadcrumb item (repeatable)
item_url	string	/	Link location for breadcrumb item (repeatable)
showBetaBanner	boolean	true/false	Should the beta banner be displayed
deskProToken	string	PTA	Token defined by DeskPro to denote your service

To run locally

## Update service manager config.
cd $WORKSPACE/service-manager-config && git pull

## Prepare MongoDB for take-off by increasing `ulimit` … 🚀
sudo launchctl limit maxfiles 65536 200000

## Clone the repo.
cd $WORKSPACE
git clone git@github.com:hmrc/pertax-frontend.git

## Start the services and stop the frontend.
sm --start PTA_ALL -r
sm --stop PERTAX_FRONTEND

## Run tests and then run the service.
cd $WORKSPACE/pertax-frontend
sbt -mem 6699 test
sbt -mem 6699 'run 9232'

## Service is now running at http://localhost:9232/personal-account/

Code quality

There are pre-commit checks against the JS and SCSS files with ESLint and Stylelint. You can run these together or one at a time.

npm run lint:js checks the JS files
npm run lint:scss checks the SCSS files
npm run lint checks both JS & SCSS files

Any files which do not require linting — minified library files, legacy vendor files, etc. — should be added to the relevant ignore file:

.eslintignore
.stylelintignore

If you absolutely have to bend a rule, disable it at the top of your file:

/* eslint-disable sonarjs/no-duplicate-string */

/* stylelint-disable selector-max-compound-selectors */

And always declare external globals, for example:

/* global $, GOVUK */

VS Code additions

To help those in design and front-end who use VS Code instead of IntelliJ, there are some additional files in this repository.

extensions.json: recommends a set of extensions to help with a Scala development environment, as well as debugging and linting tools, and things to generally help you commit more consistent code. Run these from in the Workspace Recommendations section of the Extensions sidebar.
launch.json: a set of debug configurations to help debug your code with the help of various browsers and tools. Run these from in the Debug sidebar.
tasks.json: some sbt tasks to manage the service and get it running. Run these from the Command Palette. shift+cmd/ctrl+p, and choose “Tasks: Run Task” to see the available options. (NPM tasks are in the NPM section)

License