added readme to project

2026-10-12 19:13:45 +03:00 · 2024-03-10 17:20:30 +02:00
parent 498ed385e3
commit 9fc5d57be7
1 changed files with 20 additions and 0 deletions
@@ -0,0 +1,20 @@
+# Bort - Bus or Tram
+
+This app displays the 5 next departure times for public transport of two hard-coded stops. 
+
+## Running the application
+
+Easiest way to run these applications is by using `docker compose`. The app can also be run by first starting the backend and then the frontend. Don't forget to add .env files!
+
+
+## Testing
+
+Overrated... :D
+
+## Roadmap
+
+[ ] Ability to change the stops
+[ ] Support for variable amount of stops
+[ ] Support for changing the amount of departure times
+[ ] Take in count the walking time to the stop
+[ ] Better css