Required Software

  1. Git

  2. Python

  3. Firefox web browser

  4. Geckodriver

  5. MySQL (preferably with MySQL workbench)

Local Setup

  1. Clone the repository

  2. Create the following environment variables:



    • DB_USER


    • DJANGO_EMAIL_HOST_USER - a gmail account

    • DJANGO_EMAIL_HOST_PASSWORD - password to the gmail account (prefarably an app password)

  3. Create and activate a virtual environment using pipenv by running $ pipenv shell

  4. Install dev dependencies by running $ pipenv install --dev

  5. Run the tests using $ python test --settings=resource_center.settings.test.

    • Make sure you have geckodriver installed and in your PATH before attempting to run the test. Read selenium python docs for more information on how to do this.

    • You could also add this flag --exclude-tag=functional to run unit tests only.


  • Environment variables can be stored in a .env file in the repository root. Pipenv automatically sets the variables defined in .env as environment variables when the virtual environment is activated.