-
Fork the repository
-
Clone the forked repository to create a project in your IDE
-
Create and activate a virtual environment in the project folder e.g.
- MacOS:
python3 -m venv .venvthensource .venv/bin/activate - Windows:
py -m venv .venvthen.venv\Scripts\activate
- MacOS:
-
Check
pipis the latest versions:pip install --upgrade pip -
Install the requirements. You may wish to edit requirements.txt first to remove the packages for Flask or Dash if you only want to complete the activities for one type of app.
- e.g.
pip install -r requirements.txt
- e.g.
-
Install the paralympics app code e.g.
pip install -e .
There are two versions of the activities. You can complete both, or just the version for the framework you intend to use for coursework 2.
This repository contains 4 apps used in the activities which may cause some confusion for imports.
You must remember to run pip install -e .
The 4 apps can be run from the terminal as follows, you may need to use 'py' or 'python3' instead of 'python' depdending on your computer:
- Dash app:
python src/paralympics_dash/paralympics_dash.py - Dash multi-page app:
python src/paralympics_dash_multi/paralympics_app.py - Flask REST API app (coursework 1):
flask --app paralympics_rest run --debug - Flask app:
flask --app paralympics_flask run --debug