README.md

Reveal Frontend

This is the Reveal web application front end.

The structure of this repo is inherited from create-react-app.

Guidelines

• We try follow the BEM or Block Element Modifier guidelines for CSS.
• We strictly follow the three principles of redux.

Getting started

First, copy the included .env.sample into .env

cp .env.sample .env

Next install packages using yarn and then start the app:

yarn

yarn start

Configuration

The configurations are located in the configs directory and are split into two modules:

• env.ts: this module reads configurations from environemt variables
• settings.ts: this module holds more complicated configurations

Testing

yarn test

Run test and generate coverage report

Generating reports significantly slows down your tests. Therefore, use this option when you only need a coverage report.

yarn test:coverage