Skip to content

Latest commit

 

History

History
63 lines (46 loc) · 2.75 KB

README.md

File metadata and controls

63 lines (46 loc) · 2.75 KB
Raw

DepartureBoard

Netlify Status "Buy Me A Coffee"

Welcome

This project is an angular website designed to present the UK and German train departures in a way similar to the led boards you find in stations accross the UK. For more info please see https://www.leddepartureboard.com

How to Use

  1. To change the station just modify the url. E.g http://your-site.com/EUS will show euston station times
  2. To change the amount of boards on the screen just add a number to the end. E.g http://your-site.com/EUS/12
  3. To view a platform style board just modify the url with a prefix of 'singleboard'. E.g http://your-site.com/singleboard/EUS

Working Example

To view a running example head over to https://www.leddepartureboard.com/EUS/12

Technology

  • Angular frontend using typescript as the scriping language.
  • C# asp.net core backend to retrieve the departure data.
  • Runs using dotnet core so is cross compatible accross operating systems.
  • Uses google firebase as the document storage and user authentication.

Docker

This project is also build into a docker image every time we merge to master. This means you can run this website very easiy simply by runnning the command
docker run -p 8080:80 -e "RealTimeTrainsToken=[INSERT_REALTIMETRAINS_TOKEN_HERE]" benfl3713/departure-board
This will run the website on port 8080 of the host

There is also a docker-compose file in this repository that will make it easier to spin up the website with the command
docker-compose up

Run locally

  1. Make sure you have the following installed on your machine

  2. Clone this repository locally

    git clone https://github.com/benfl3713/DepartureBoard.git
cd DepartureBoard

  3. Install dependencies

    cd DepartureBoardWeb/ClientApp
npm install

  4. Create config.xml file inside DepartureBoardWeb, and put the following in, making sure to put you realtimetrains token in

    <Config>
  <RealTimeTrainsToken>[INSERT_REALTIMETRAINS_TOKEN_HERE]</RealTimeTrainsToken>
</Config>

  5. Either use vscode and press F5 to run the application, or inside the DepartureBoardWeb folder run dotnet run