TL Mobile

app.talkinglibrary.nashville.gov

a simple mobile app for TL listeners...

Requirements

Python

• Use version 3.10 or above
• The production server is running version 3.12
• Make sure to select "add to PATH" during installation.

Development

• Clone this depository

  git clone https://github.com/Nashville-Public-Library/TL-mobile.git

• cd into the directory

  cd TL-mobile

• Create a virtual environment

  py -m venv venv

  • Depending on your OS, instead of py you may need to use python or python3

• Activate virtual environment

  • On Windows:

  venv\Scripts\activate

  • On Mac:

  source venv/bin/activate

  [IMPORTANT] If done correctly, you should see (venv) in the terminal. Do not continue unless you see (venv) in the terminal.

• Install Dependencies

  pip install -r requirements.txt

• Install Browser Drivers (for running the tests)

  playwright install chromium

• Launch the app

  flask run --debug

• To Run the Tests

  pytest

  • Always run the tests before pushing changes

Misc

If you add 3rd party libraries, don't forget to add them to the requirements.txt file as you go:

pip freeze > requirements.txt