This is the official repository of the open bus (תחב"צ פתוחה) project - also known as "ShameBus". link to the project
- While in the site, type "storybook" (in lowercase) to see a secret 😉
Please feel free to submit pull requests and contribute to the project (see the "contribution" section).
This app is created by the volunteers of Public Knowledge Workshop
- fork the repo
- clone the repo
yarn install
yarn start
command | description |
---|---|
yarn test:unit |
Run the unit tests using watch option (good for development). |
yarn test:unit:ci |
Run the unit tests (good for ci). |
yarn test:e2e |
Run the e2e (playwright) tests (good for ci). |
yarn test:e2e:ui |
Run the e2e (playwright) tests with user interface. |
yarn test |
Run all the kind of tests. |
- additional helpful flags - https://playwright.dev/docs/test-cli
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
- the API client
- the data API
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.
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.