This is an Express API with Node.js and Google App Engine for the RIDDIMFUTÁR app.
This project is not afflitiated with the Budapesti Közlekedési Központ (BKK) and the Forgalomirányítási és Utastájékoztatási Rendszer (FUTÁR) in any way. This project is solely for educational and experimental purposes.
This Express API serves the Flutter application (that can be found in this repository) with the nearby stops, the routes, the upcoming stops of the selected route, and the URLs for the sound files (both the music loops and the local announcments, such as the "The next station is Deák Ferenc tér" recording).
The stop and route data are provided by the BKK via the BKK FUTÁR API.
Our API has the following endpoints:
- GET /metadata
- Get BKK bounds, messages from the developer, etc.
- GET /vehicles?lat={lat}&lon={lon}
- Get nearby vehicles. Provide the user latitude and longitude in the URL params.
- GET /vehicle/{id}
- Get a particular vehicle's data. Useful for downloading the sound signal of the stop.
- GET /music/{genre}
- Get a random music ID that the user will hear for the next stop. The URL will be downloaded from the bucket, alongside it's metadata (like the artist and an album art) and waveform.
npm i
npm run dev- .envrc is used locally, automatically passed into the app via the CLI (e.g. when testing)
config/dev.jsonandconfig/prod.jsonare used in the appropiate deployment environment - an example is provided for both files For more info about the hows and whys, refer to this blogpost.