Skip to content

amabelleS/open-bus-map-search

 
 

Repository files navigation

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 (see the "contribution" section).

View video (Hebrew language):

video (hebrew) about the project

deployments

Netlify Status

This app is created by the volunteers of Public Knowledge Workshop

Contribution:

Running the project:

  • fork the repo
  • clone the repo
  • yarn install
  • yarn start

testing the project:

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.

useful resources:

submitting pull requests

Thanks for your willingness to invest time and help us improve!

  1. 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.
  2. Please make sure that the project works on your computer
  3. Please tag one of the maintainers as reviewers we're here to help! feel free to join our Slack channel

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.

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.

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 90.9%
  • SCSS 5.2%
  • JavaScript 2.9%
  • Other 1.0%