Skip to content
This repository has been archived by the owner on May 7, 2020. It is now read-only.

hmrc/wristband-frontend

Repository files navigation

wristband-frontend

A frontend client for the Wristband deployment service. Communicates directly with, and is dependent on Wristband REST API.

README contents:

Installation

n.b. You also need to have the wristband API running locally to run the frontend. See the Wristband API installation instructions here

  • $ git clone https://github.com/HMRC/wristband-frontend.git
  • $ cd wristband-frontend
  • $ pip install -r requirements.txt
  • $ python wsgi.py

The app will now be running: http://127.0.0.1:5000/

If you've followed the API docs, it should also be running: http://127.0.0.1:8000/api/

Mock

The app has a mock API that can be used when running locally. To start the mock:

  • $ cd mock
  • $ npm install
  • $ npm start

The mock communicates with the API to get the app data, and currently mostly just mocks the deployments.

Tests

A set of Jasmine tests exist in the /test directory. To run the tests:

  • $ cd test
  • $ npm install
  • $ npm test

Stack

The stack has been chosen based on what is familiar and maintainable within the wider team.

The app is Python based, and uses Flask to provide basic routing and templating via Jinja 2.

The frontend is built using Semantic UI, as Semantic provides a rich suite of components that require little additional work.

DataTables is used to provide the filtering of the deployment table. In the spike, we're only using the search feature of DataTables, but it supports much more - DataTables options

Routing

The app contains a few basic routes in views.py:

  • GET /login - the login page
  • GET / - the deployments page

About

Internal tool for promoting releases through environments and managing services.

Resources

License

Stars

Watchers

Forks

Packages

No packages published