Open bus ranking app
Welcome!
This is the official repository of the open bus (תחב"צ פתוחה / דאטאבוס) project - also known as "ShameBus". link to the project
Please feel free to submit pull requests and contribute to the project. For more details about contributing, see the CONTRIBUTING.md file.
Running the project locally
An explanation how to run the project locally you can read here.
View video (Hebrew language):
The video will explain you how to contribute to the project:
Easter eggs
We've hidden a couple of fun surprises in our web app, just for you. Discovering them is as easy as typing a few magic words on your keyboard.
How to Find the Easter Eggs
- Open our web app
-
Unleash the Magic Words: To reveal the hidden gems, use your keyboard to type the following commands:
- Type "storybook": Watch the magic unfold as you type "storybook" on your keyboard. You might just stumble upon our Storybook, a treasure trove of UI components showcasing the beauty and functionality of our app.
- Type "geek": To get some experimental charts with some additional data and aggregation
deployments
This app is created by the volunteers of Public Knowledge Workshop
submitting pull requests
Thanks for your willingness to invest time and help us improve!
- If you're new to GitHub, here is a tutorial describing Pull Requests. if you're familiarized with Merge Requests - it's the same concept.
- Please make sure that the project works on your computer
- Please tag one of the maintainers as reviewers we're here to help! feel free to join our Slack channel
Links for developers
Related Repositories
- the API client
- the data API
API client
The client is a JS library that provides methods and data models. for example:
https://github.com/hasadna/open-bus-map-search/blob/main/src/model/busStop.ts#L4
link to repo.
Contributors
data API
The API is backend code that provides us with data and aggregations from the DB
You can see it's endpoints here:
https://open-bus-stride-api.hasadna.org.il/docs
link to repo.