i-sense flu app

Frontend component of the i-sense flu application. Displays model scores produced by the i-sense flu api component https://github.com/UCL/isenseflu-api-flask

Background

i-sense flu is a multi-module application that uses Google search data to estimate influenza-like illness (flu) rates in England. The i-sense flu app module offers a web interface to visualise the data produced by the i-sense flu api module.

Features

• Charts generated with Chart.js https://www.chartjs.org/
• Allows the display of confidence intervals in the chart
• Supports the display of multiple models
• Scores can be downloaded in CSV format

Technologies

• ECMAScript 6
• React
• Material UI 5
• Node
• REST

Installation

Requirements

• Node >= 12.4
• npm >= 6.9
• serve (optional)

Building

Pass the REACT_APP_API_HOST variable pointing to the backend component that serves the data for Frontend app.

REACT_APP_API_HOST=[relative_path_to_api_endpoint] npm run build

Run the app

The web application can be run with serve (install with npm install serve -g)

serve -s build

serve uses port 5000 by default.

Testing

Test coverage

Install make-coverage-badge:

npm install -g make-coverage-badge

Run test with the coverage option. It must include the json-summary reporter to generate the badge:

npm test -- --coverage --watchAll=false --coverageReporters json-summary html
make-coverage-badge --output-path coverage.svg

Reporting bugs

Please use the GitHub issue tracker for any bugs or feature suggestions:

https://github.com/UCL/isenseflu-app-react/issues

Contributing

Pull requests are welcome. For major changes, especially changes that require the addition to new dependencies, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate. Follow AirBnB Javascript style in both test and target files. Use the version of eslint provided by React Create App included in this project.

Authors

• David Guzman (Github: @david-guzman)

Acknowledgements

i-senseflu app is supported by the EPSRC IRC project i-sense (Early-Warning Sensing Systems for Infectious Diseases).

Copyright

i-senseflu app is licensed under the GNU General Public License, v3. A copy of this license is included in the file LICENSE.md.

© 2019 UCL (https://www.ucl.ac.uk).