Skip to content
This repository has been archived by the owner on Apr 12, 2021. It is now read-only.

madetech/academy20-zingtech-frontend

Repository files navigation

HMRC-HR Frontend

The frontend to Bristol ZingTech's CharlieHR competitor.

Getting started with a local dev environment

  1. Clone this repo and cd into the project directory

  2. Install Node.js packages: npm install

  3. Run tests: npm test

  4. Start local server: npm start

Local testing

Tests use the Jest framework and are located in src/tests.

Run tests from the command line using npm start.

Tests are also run in build by CircleCI.

Build and deploy

To deploy to production in Heroku via CircleCI:

  • Push changes to main branch

OR

  • Push to feature branch and merge with main

CircleCI will build in this pipeline and, if tests pass, deploy to production.

GOV.UK Design System

This project aims to comply with the GOV.UK Design System, a style/pattern guide for government services.

Pre-built, configurable React components in the GOV.UK style are importable via NPM. For example:

import InputField from '@govuk-react/input-field';

<InputField
   name="group1"
   hint={[
     'It’s on your National Insurance card, benefit letter, payslip or P60.',
     <br />,
     'For example, ‘QQ 12 34 56 C’.',
   ]}
 >
   National Insurance number
</InputField>

Results in:

Example InputField component

More info at the GitHub repo for these components and there is also a Storybook of available components and their use cases.

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •