Live service times in the UK.

This is a Flask + SQLAlchemy web application running on a PostgreSQL DB.

Clone the repo:

git clone https://github.com/macph/nextbus.git

The server can be set up using Docker or installed locally with poetry. If you're using Docker Compose, docker_compose.yml assumes you've added nxb_config.py and gu_config.py to the instance folder ignored by git.

mkdir instance

echo 'SQLALCHEMY_DATABASE_URI = "postgresql://prod:hello_world@postgres:5432/nextbus"
SECRET_KEY = b"your secret key"' > instance/nxb_config.py

echo 'bind = ["0.0.0.0:8000"]' > instance/gu_config.py

See default_config.py for all options.

Use docker-compose up or poetry install to set up the application.

PostgreSQL must be at least version 11 to support particular full text search functionality.

With the configuration set up, use docker or poetry run to access the application. Run the database migrations:

python manage.py db upgrade

Populate with data:

python manage.py populate --all

which will download NPTG, NaPTAN and NSPL data and commits them, as well as doing some modifications. If you've added TNDS FTP credentials to the config, TNDS service data will be added as well. Run the server locally in development mode with

python manage.py run

or run the Docker container.

Live bus times are retrieved with Transport API - a account is required to use application ID/key. Sample data is used as backup for testing if no key exists.