Skip to content

Latest commit

 

History

History
40 lines (28 loc) · 1.24 KB

README.md

File metadata and controls

40 lines (28 loc) · 1.24 KB

Coverage Status

Water widget

A react app made to function as a "widget" for the when the water comes/Når vandet kommer campaign.

The design for the app was made in Adobe XD the design can be seen in the design folder.

Technical setup

The repo conforms to the 12 factor principles, to configure the app copy .env.example to .env.development.local and fill in the values.

The code is written using React, to get a local setup install node and run

$ npm install
$ npm start

There are both some unit tests using jest and end-2-end tests using cypress. To run the tests execute

$ npm test # Unit/snapshot tests
$ npx cypress run # E2E tests --- `npm cypress open` shows cypress output

Remember to run npm start before using cypress.

Code structure

The src/views folder contains the general pages of the app which is built using the pieces in src/components. Non UI code is in the data-handlers folder.

The recommended articles and text for the risks are in the articles.json and risk.json files.