https://github.com/onaio/reveal-frontend
WebUI for the Reveal epidemiological surveillance platform
https://github.com/onaio/reveal-frontend
epidemiology hacktoberfest malaria react surveillance
Last synced: about 2 months ago
JSON representation
WebUI for the Reveal epidemiological surveillance platform
- Host: GitHub
- URL: https://github.com/onaio/reveal-frontend
- Owner: onaio
- Created: 2019-02-06T20:52:59.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2023-02-07T07:43:45.000Z (over 2 years ago)
- Last Synced: 2025-04-28T15:02:10.490Z (about 2 months ago)
- Topics: epidemiology, hacktoberfest, malaria, react, surveillance
- Language: TypeScript
- Homepage:
- Size: 25.3 MB
- Stars: 8
- Watchers: 29
- Forks: 4
- Open Issues: 114
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Reveal Frontend
[](https://coveralls.io/github/onaio/reveal-frontend?branch=master)
This is the Reveal web application front end.
The structure of this repo is inherited from [create-react-app](https://github.com/facebook/create-react-app).
## Guidelines
- We try follow the [BEM](https://en.bem.info/methodology/quick-start/) or Block Element Modifier guidelines for CSS.
- We strictly follow the [three principles of redux](https://redux.js.org/introduction/three-principles).
## Getting started
First, copy the included `.env.sample` into `.env`
```sh
cp .env.sample .env
```
Next install packages using yarn and then start the app:
```sh
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
```sh
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.
```sh
yarn test:coverage
```