Running the application locally

Instructions taken from here, if you run into any issues might be good to reference this as well.

The application itself can be found here on our GitHub if you just wish to browse the source code without downloading it to your machine.

  1. Clone the project from GitHub, and enter it; ensuring you're in the right directory (that contains files such as and requirements.txt is very important, pretty much every step expects you to be in the one directory).
git clone
cd ./dev-bootcamp-v1.0/example-portfolio
  1. Ensure you're running Python 3, this is covered in more detail within the setup, but a good sanity check before continuing.
python3 --version
  1. Create a virtual environment, so you can install packages locally to the project without populating the global python package namespace, and also without needing root to install packages either. More info on virtual environments here.
cd path/to/dev-bootcamp-v1.0/example-portfolio
python3 -m venv venv
  1. Activate the virtual environment, depending on your shell this might be different.
cd path/to/dev-bootcamp-v1.0/example-portfolio
. venv/bin/activate
  1. Install all of the required application dependencies.
cd path/to/dev-bootcamp-v1.0/example-portfolio
pip install -r requirements.txt
  1. Finally, run the application, and then open your browser to http://localhost:3000; if everything went correctly you should now see the example application!
cd path/to/dev-bootcamp-v1.0/example-portfolio
flask run

Don't fret to ask for help in the Discord if you run into any issues with the above commands.