🦠 The free & open source infectious illness tracker.
To contribute to this project you must contribute to one of the following:
- New illness support
- React frontend
- Backend work
In order to contribute, please do not make extremely small or unnecessary changes. If you are going to fix spelling/grammar please try to fix as much as possible and check over your woek. However, if you are contributing to code, it may take several hours or days for a response.
- Node.js (v 14.17.1): Install Here
- Git (any version): Install Here
The first thing you need to do is clone the repository locally. To do this run the following command in the terminal:
git clone https://github.com/sqwyer/GlobalIllnessTracker
If you encounter any issues, refer to the Github Documentation
Then, navigate into the cloned repository by running the following command in the terminal:
cd ./GlobalIllnessTracker
Now that you have the repository cloned, you can start editing files. Try your best to avoid bugs by testing your code in your browser, you can start the app by running the following commands in the terminal: Please note: you will need to have 2 terminals open in order to do this:
Terminal One
npm run start
Terminal Two
cd ./client && npm run start
Please note: if you are going to be contributing to the React frontend, try your best to stick to the Figma Mockup. If you think something in the mockup should be changed, or have an all new mockup that you think could work well, contact me via Discord or email (see my profile for contact information).
- MIT - License File