simrail / EDR

EDR timetable & driver view for Simrail
https://edr.simrail.app
GNU General Public License v3.0
25 stars 12 forks source link

Add development instructions and a docker-compose setup #103

Open HakierGrzonzo opened 3 months ago

HakierGrzonzo commented 3 months ago

I like using this app while dispatching, and as I am also a developer I gave it a look.

I found the process of starting the application to be somewhat hard, so I made it easier (and added docs).

I made the following changes:

  1. I added docker-compose.yml
    • Now all the containers needed for development can be built via a single command.
    • We could create a separate docker-compose.prod.yml that will also contain all the setup for frontend and nginx services. This would allow us to remove all the placeholder example.org from the nginx config.
  2. I added the info on how to launch the app to README.
  3. I have added a fallback when the developer does not provide a valid STEAM_API_KEY:
    • We display the following on failure: image
    • I could remove it if you don't like it

I have also noticed that the code is not formatted, maybe we should add and enforce prettier? I could setup github-actions for that if you want.