Project Handover Manual

Intended audience

Readers should be familiar with Object Oriented Programming, UML, design patterns, C#, git. Knowledge of railway signalling is a pre.

1. Reading material

A quick start for this project is available below.

• App Structure
• How is IMSpoor translated to EULYNX?
• Main topology translation
• Model logic
• Data Management
• Mapping
• Objects and References in EULYNX C#

2. Setting up your environment

Clone
Decide how you want to continue on the project. The project can be pulled from this repository or forked into your own.

1. Cloning this repository

1. Create a personal access token on GitHub. You can do this by following this tutorial on GitHub: https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token

2. Clone the repository on your local machine Clone the repository with your personal access token using HTTPS.

$ git clone https://github.com/JVerbruggen/IMSpoorToEulynx.git
Username: your_username
Password: your_token

2. Create a fork

1. Navigate to this project's homepage, click the Fork button.
2. Clone your own forked repository on your local machine

IDE
Load the solution into your IDE, preferably Visual Studio. During the development Visual Studio Community 2019 was used (Version 16.7.6).

Run
Run the application by running 'FormsApp', which is the current frontend of the application. It should work right away.

Should you need to specify a runtime, the FormsApp is targeted for .NET Core 3.1, but the underlying layers are all .NET Standard 2.0. This is done for future user interfaces that are used on systems that do not support .NET Core 3.1.