/OpenTTD-master-server-web

Web frontend for the Master Server Public Server Listing

Primary LanguagePythonGNU General Public License v2.0GPL-2.0

Master Server web front-end

GitHub License GitHub Tag GitHub commits since latest release

GitHub Workflow Status (Testing) GitHub Workflow Status (Publish Image) GitHub Workflow Status (Deployments)

GitHub deployments (Staging) GitHub deployments (Production)

This is a front-end for the Master Server Public Server listing. It works together with master-server, which serves the HTTP API.

Development

This front-end is written in Python 3.7 with Flask.

Running via devcontainer / VSCode Remote Containers / GitHub Codespaces

If you open up this repository with VSCode Remote Containers or GitHub Codespaces, it will automatically set up the development environment for you.

Press F5 to start the webserver using the production API. Go to "Ports" to open the website.

Happy editing!

Running locally

To start it, you are advised to first create a virtualenv:

python3 -m venv .venv
.venv/bin/pip install -r requirements.txt

After this, you can run the flask application by running:

make run

Running via docker

docker build -t openttd/master-server-web:local .
docker run --rm -p 127.0.0.1:5000:80 openttd/master-server-web:local