TrainSpotter

Live train and disruption information of the Dutch railroad
TrainSpotter website »
Explore the docs »

treinenkaart.bartvanzeist.nl · Report Bug · Request Feature · bartvanzeist.nl

Table of Contents

1. TrainSpotter
   • Built With
   • Specific technologies
2. Getting Started
   • Prerequisites
   • Installation
3. Project Management
   • Feature management
   • Development
   • Continuous Integration and Delivery
4. Roadmap
5. License
6. Contact

TrainSpotter

TrainSpotter is a website that tracks trains on the Dutch railroad in real-time. TrainSpotter offers features such as:

• Real-time train tracking
• Global search for stations, trains, train types, train parts and ride id's
• Detailed, real-time information for each specific train

Built With

• Angular
• MapBox
• Ng-Bootstrap
• NS API

Specific technologies

• Web Workers (for MapBox and Jimp image manipulation)
• Service Workers
• LocalStorage (for content caching)

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• Angular
  • See Angular docs
• Yarn

  npm install --global yarn

Installation

1. Clone the repo

   git clone https://github.com/BPHvZ/Train-Spotter.git

2. Install Yarn packages

   yarn install

3. Run TrainSpotter sh yarn run serve

Project Management

Feature Management

1. New features are tracked on the Project board.
2. When a feature is going into development, it is converted into an Issue.
3. A person is assigned to the Issue. A bot will create a feature branch for the Issue.
   • By default, the feature branch will be based of the develop branch.
   • Issues that are labelled as will be based of the main branch.
     Bugs are intended to be resolved quickly and thus should be implemented on main as soon as possible.

Development

1. A feature will be developed on its designated feature branch.
2. A pre-commit hook is included which can be enabled by running yarn husky install.
   • The pre-commit hook will run Prettier and ng lint using the linting rules included with this project.
3. Compodoc is used to generate documentation. Compodoc strings should be added before making a pull request.
4. Feature branches can be pushed into the develop branch.
5. The main branch is protected and only accepts pull requests that have completed the CI/CD tasks successfully.

Continuous Integration and Delivery

1. Teamcity is run locally.
2. All changes on the develop branch will cause the CI to build and deploy the experimental version of TrainSpotter at betatreinenkaart.bartvanzeist.nl.
3. Pull requests from the develop branch to the main branch will build and deploy the new stable version to treinenkaart.bartvanzeist.nl

Roadmap

See the Project on GitHub for a list of proposed features (and known issues).

License

Distributed under the GNU GPL v3 License. See LICENSE for more information.

Contact

Bart van Zeist - bartvanzeist.nl - LinkedIn - bartvanzeist2000@gmail.com

Project Link: https://github.com/BPHvZ/Train-Spotter