Quick Start

Quick Start

Prerequisites

• SSH key set up for Github
• Docker https://docs.docker.com/install/
• Docker-compose https://docs.docker.com/compose/install/

Setting up ui-components

• Fork this repository to your own github user.
• Run git clone git@github.com:<your username>/ui-components.git in a terminal to clone to a local folder (e.g. ~/Workspace)
• Navigate to the ui-components folder created for this clone.
• Create a .npmrc file in the root directory with the following contents:

  @fortawesome:registry=https://npm.fontawesome.com/
  //npm.fontawesome.com/:_authToken=<AUTH TOKEN HERE>
  

  • Replace <AUTH TOKEN HERE> with the Font Awesome 5 Pro auth token which can be found on 1Password. This npm configutation file will allow us to retrieve the fontawesome-pro package from a private registry.
• Install npm
  • On linux sudo apt-get npm
  • On macOS brew install npm
• Run yarn to install npm JS packages into your working folder.
• Run docker-compose build to build your docker container.
• Run docker-compose up local to start the ui-components build and the service.
• You should now be able to connect to the application in your browser using the network address output in the console