mandrecki / coronus

Web app for displaying Covid19 predictions

Setup

1. Install Python 3.8

2. Install virtualenv: pip install virtualenv

3. cd to the project root directory

4. Create virtualenv: virtualenv --python=YOUR_PYTHON_3.8_PATH venv

5. Activate virtualenv: source venv/bin/activate

6. pip install -r requirements.txt

7. Configure git (you can add --global if you would like to set this for your entire systems, not just this repo):

   git config user.name "Your Name"
   git config user.email "your@email"
   git config pull.rebase true
   git config branch.autosetuprebase always
   

8. Setup your editor. For PyCharm, configure the project interpreter in File -> Settings -> Project -> Project Interpreter. Add a new interpreter from the existing virtualenv in ./venv (the Python interpreter path should end with venv/bin/python).

9. Run the app

source venv/bin/activate
python app.py

6. Play with the graphs in browser at http://127.0.0.1:8050/

Devel process

Create your branch

git branch yourbranch
git checkout yourbranch

Make some changes and commit

git add new_file.txt
git commit -m "meaningful changes..."

See if the app works locally

python app.py

If it runs, change to staging and merge in your changes.

git checkout staging
git merge yourbranch
git push orign staging

See if the page works here. If it does, make a pull request to production on github.

You want to merge into production, but first others see your code and test changes to the app. Describe the changes briefly and tag relevant coders as reviewers.