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

Latest commit

 

History

History
30 lines (19 loc) · 1009 Bytes

README.md

File metadata and controls

30 lines (19 loc) · 1009 Bytes

Front end

Mock-ups

Mockups can be found at Figma mock-up.

Setup

To set up this project all you need to do is call npm install. This instruction will install all dependencies. After calling this, all you need to do is run npm start.

Tests

Testing the project is easy, just run npm run test. A coverage report will be printed in your terminal.

Documentation

Our development documentation can be generated by running npm run docs in this folder. Running this will generate a docs folder containing the development documentation. You can view this documentation by calling npx serve.

Development

We use the Next.js framework in combination with Typescript to implement our frontend.

We use ESLint as our linter, Jest as a test framework and Prettier to prettify our code.