Know Your Parkinson

A web application to help you detect your Parkinson's Symptoms early

Steps to start:

1. Fork this repository to your own GitHub
2. Clone your fork onto your machine
3. Install Python (Duh!)
   • I'd suggest installing PyPy and using that because it's way faster, but regular Python3 works too.
   • MacOS comes with Python2 by default and that absolutely won't work with Flask
4. Setup Virtual Environment
   • Open a terminal and:
   • pypy3 -m venv venv -> for PyPy
   • py -m venv venv -> python3
   • python3 -m venv venv -> MacOS
5. Activate Virtual Environment <- You'll have to repeat this step everytime
   • venv\Scripts\activate -> Windows (Yes, the S is uppercase)
   • venv/bin/activate -> MacOS
   • Your terminal should say venv at the start of the PATH

   •     if you see venv:
            proceed
         else:
          debug until you see venv

6. Install requirements <- You'll have to install requirements everytime there's a change in the requirements.txt file
   • pip install -r requirements.txt <- If using python3
   • pypy3 -m pip install -r requirements.txt <- If using pypy
7. Do some magic shit
   • To run the server and check the app:
     • set FLASK_APP=park.py <- Repeat everytime you have a new terminal
     • flask run <- If using python3
     • pypy3 -m flask run <- If using pypy
     • Open a browser tab and go to localhost:5000
   • When you make changes to code, most of the changes should be hotpluggable i.e refresh the page to see them
   • If a refresh doesn't work, just use CTRL+C and run the appropriate version of flask run
   • If you have to install a new dependency:
     • pip freeze > requirements.txt

Workflow:

• Once you have everything setup, commit things to your own repository
• Send pull requests to the main org repo, this will check if merges are compatible
• Everytime before starting work, it's good practice to pull and check if someone has made changes to the repo
• I know using Git can be difficult and I'm no expert either, but using GitHub desktop will make life easy if you don't already know Git.

I use GH Desktop because it's faster and easier to use.