andrew
/
RailSignalAPI
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
An app for tracking and managing your rail systems, in real time.
52 Commits 1 Branch 9 Tags 605 KiB
Java 43.4%
Vue 27%
JavaScript 19.3%
Lua 6.8%
D 2.2%
Other 1.3%
Go to file
Andrew Lalis 72b4d0dda9 Improved driver docs. 2022-06-01 15:57:06 +02:00
.mvn/wrapper Added all basic infrastructure. 2021-11-21 23:46:01 +01:00
quasar-app Improved driver docs. 2022-06-01 15:57:06 +02:00
src Fixed switch UI updating, websocket bugs, and context switching. 2022-06-01 15:54:29 +02:00
.gitignore Added build_system.d and changed to --mode=development. 2022-05-08 20:04:21 +02:00
LICENSE Initial commit 2021-11-21 13:44:20 +01:00
README.md Improved installer, and added more info to readme. 2022-05-30 09:08:25 +02:00
build_system.d Version bump, and cleaned up some frontend. 2022-05-31 13:23:24 +02:00
component-drivers.md Added first implementation of CC:Tweaked driver and improved UI. 2022-05-29 17:02:05 +02:00
mvnw Added all basic infrastructure. 2021-11-21 23:46:01 +01:00
mvnw.cmd Added all basic infrastructure. 2021-11-21 23:46:01 +01:00
pom.xml Fixed infinite redirect bug. 2022-05-31 15:24:48 +02:00

README.md

Rail Signal

A comprehensive solution to tracking and managing your rail system, in real time.

Setup

To set up your own Rail Signal, system, you will need to follow the following steps:

  1. Download and run the Rail Signal API and web app. Go to the releases page to download the latest release. Then, place the JAR file in your desired location, and run it with java -jar rail-signal.jar.
  2. Open the web app (http://localhost:8080 by default) and create a new rail system, and add components and segments to build your network. More information about this will be given later.
  3. Add components to your actual rail system, and install a driver script onto your device. For Minecraft rail systems using Immersive railroading and some computer mod, you can run pastebin run jKyAiE8k to run an installation script. Please make an issue if you have a system for which there is not yet any available driver.

Development

To work on and develop Rail Signal, you will need to run both the Java/Spring-Boot backend API, and the Vue/Quasar frontend app.

To start up the API, the project directory in IntelliJ (or the IDE of your choice), and run the RailSignalApiApplication main method.

To start up the app, open a terminal in the quasar-app directory, and run quasar dev.

Building

To build a complete API/app distributable JAR file, simply run the following:

./build_system.d

Note: The build script requires the D language toolchain to be installed on your system. Also, you can compile build_system.d to a native executable to run the build script more efficiently.

This will produce a rail-signal-api-XXX.jar file in the target directory, which contains both the API, and the frontend app, packaged together so that the entire JAR can simply be run via java -jar.