README.md

UK Railway Dot Matrix

Displays a dot matrix station display board for any UK railway station.

Uses the National Rail API via my own personal instance of Huxley2.

See it live at raildotmatrix.davwheat.dev!

Running locally

You'll need:

• Node.js 20 or later (not tested on earlier versions)
• Yarn package manager
• Git

When you have cloned the repository with Git, you should install all required dependencies with Yarn:

yarn install

Then, you can run the Gatsby development server with:

yarn run start

Finally, you need to start the backend worker to allow live data to be fetched from the Darwin API:

yarn run develop:workers

You can then access the site at the URL provided from the last command. This is usually http://localhost:8788.

Contributing

Please feel free to contribute to this project! You can do so by forking the repository and creating a pull request.

Please make sure you format your code before submitting a pull request. You can do this by running:

yarn run format