Pi MTA Sign!
This project gives you a docker image that you can run locally to pull MTA data and self-host a webpage that looks very similar to the classic MTA Signs found in the metro.
Initially designed to run directly on a raspberry pi, it has been containerized and now runs anywhere you can install podman or docker!
Running the Docker Image
Prerequisites
- Docker installed on your system
Quick Start with Docker
Pull the latest image from GitHub Container Registry:
docker pull ghcr.io/lucasoskorep/pi-mta-sign:latest
Run the container:
docker run -d \
-p 8000:8000 \
--name pi-mta-sign \
ghcr.io/lucasoskorep/pi-mta-sign:latest
The application will be available at http://localhost:8000
Environment Variables
| Variable | Description | Default | Required |
|---|---|---|---|
FRONTEND_ENABLE |
Enable/disable the web frontend | true |
No |
Running with Docker Compose
For a more convenient setup, use the provided docker-compose configuration:
# Copy the example docker-compose.yaml from the docker folder
cp docker/docker-compose.example.yaml docker-compose.yaml
# Run with docker-compose
docker-compose up -d
See docker/docker-compose.example.yaml for a complete example configuration.
Local Development
To develop on this app locally you can clone the repo and then in the repo root run the following
Tools needed:
Once you have all the required tooling all you need to do is
just init # downloads python
just dev # this will spin up the nextjs frontend and fastapi backend in hot reload mode