search

bhaden94 / covid-19-tracker-v2-fe

Typescript React frontend for a visualization of key numbers associated with Covid-19
https://covid-tracker-v2.herokuapp.com/
MIT License
1 stars 0 forks source link
devexpress material-ui react typescript

readme

Covid-19-Tracker-V2-Frontend

code-quality-shield ![code-grade] Forks Stargazers Issues MIT License LinkedIn


Logo

Covid Tracker V2 Frontend

Visualization dashboard to see key data related to Covid-19.
View Live Application · Report Bug/Request Feature · Code Inspector Dashboard

Table of Contents

Built With

Getting Started

To install the React frontend follow these steps below. It is recommended to install and run the backend first. Steps on how to do that are found in the backend repository

Prerequisites

Node and npm must be installed. How to do this can be found here.

Installation

  1. Clone the repo 
    git clone https://github.com/bhaden94/covid-19-tracker-v2-fe.git
  2. Install NPM packages 
    npm install
  3. Start the react app

    NOTE: The backend should be installed and running first or else the front end will not be able to proxy any requests. See documentation here to get the backend running.

    npm start

Usage

This app was built to give you a visual dashboard for the key data as it relates to the Covid-19 virus.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be; learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Brady Haden - LinkedIn

Acknowledgements