Skip to content

Latest commit

 

History

History

client

Corona Tracker Logo

Build Status

A tool to help reduce the number of unnecessary hospital visits, educate the public on facts vs myths, and provide a health and wellbeing chart for logging their journey during these uncertain and tumultuous times.

Get involved and help out!

Application Overview

View our contributing guidelines to learn more about the project, our values, and regular town hall meetings for the group.

View our support document to learn more about the project leads, resources, and technology.

Front-End Overview

Technology Stack: React, Material UI, Jest

Material UI

React

Useful Github Repo Links

Wireframe Overview

app overview

Questions?

Feel free to chat with us on Discord and message @Anthony A if you have any questions!

Our group is new developer friendly and happy to help in any way!

We also welcome your Github contributions and encourage opening an issue before filing a pull request. Please see our contributing guidelines for more information.

Appendix

Design considerations

CSS Design considerations

We have decided to use regular CSS files to keep things simple for now. This allows for more contributors and less time to upskill to contribute.

Once the MVP is done the team can discuss if we want to transition it to styled-components or something like CSS modules.

Folder paths:

  • CSS files are located in /client/src/css
  • Components are located in /client/src/components

Scripts

Always use yarn not npm or the app will break. In the project directory, you can run:

Yarn

Full list of yarn commands

yarn install

  • Install all node modules
  • Similar to npm i
  • More Info

yarn add

  • Installs a package and any packages that it depends on
  • Similar to npm install <package-name>
  • More Info

yarn remove

  • Removes an unused package from your current package.json
  • Similar to npm uninstall <package-name>
  • More Info

yarn init

  • Initializes the development of a package.
  • Similar to npm init
  • More Info

yarn upgrade

  • Upgrades packages to their latest version based on the specified range
  • Similar to npm update <package-name>@<verision>
  • More Info

yarn lint

  • Runs ESLint to clean up code before you submit any pull requests.

yarn start

  • Runs the app in the development mode.

  • Open http://localhost:3000 to view it in the browser.

  • The page will reload if you make edits.
    You will also see any lint errors in the console.

yarn test

  • Launches the test runner in the interactive watch mode.
  • See the section about running tests for more information.

yarn build

  • Builds the app for production to the build folder.

  • It correctly bundles React in production mode and optimizes the build for the best performance.

  • The build is minified and the filenames include the hashes.

  • Your app is ready to be deployed!

  • See the section about deployment for more information.

yarn eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

Git / Github

Git Resources

⚠️ 👀 WARNING: You should use rebase only for squashing YOUR local commits prior to a pull request. DO NOT ever to rebase commits that have already been published to master. This will rewrite our public project's history. This applies to maintainers of the project.

Github Resources