https://github.com/hasadna/open-bus-map-search

open-bus-map-search
https://github.com/hasadna/open-bus-map-search

bus hacktoberfest israel jest mot playwright playwright-javascript react transportation transportation-planning

Last synced: 3 months ago
JSON representation

open-bus-map-search

• Host: GitHub
• URL: https://github.com/hasadna/open-bus-map-search
• Owner: hasadna
• License: mit
• Created: 2023-03-21T06:45:36.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-01T16:17:13.000Z (9 months ago)
• Last Synced: 2024-05-02T02:02:05.318Z (9 months ago)
• Topics: bus, hacktoberfest, israel, jest, mot, playwright, playwright-javascript, react, transportation, transportation-planning
• Language: TypeScript
• Homepage: https://open-bus-map-search.hasadna.org.il/dashboard
• Size: 14.7 MB
• Stars: 39
• Watchers: 5
• Forks: 72
• Open Issues: 66
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

• awesome-opensource-israel - DataBus

README

        
# Open bus ranking app

## Welcome!

This is the official repository of the open bus (תחב"צ פתוחה / דאטאבוס) project - also known as "ShameBus".

[link to the project](https://open-bus-map-search.hasadna.org.il/dashboard)

Please feel free to submit pull requests and contribute to the project.

For more details about contributing, see the [CONTRIBUTING.md](CONTRIBUTING.md) file.

# Running the project locally

An explanation how to run the project locally you can [read here](CONTRIBUTING.md#running-the-project-on-a-local-environment).

## View video (Hebrew language):

### The video will explain you how to contribute to the project:   

[![video (hebrew) about the project](https://img.youtube.com/vi/6H6jkJCVhgk/0.jpg)](https://www.youtube.com/watch?v=6H6jkJCVhgk)

# 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

1. Open our [web app](https://open-bus-map-search.hasadna.org.il/dashboard)

2. **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](https://www.hasadna.org.il/)

### 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](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request). 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](https://join.slack.com/t/hasadna/shared_invite/zt-21qipktl1-7yF4FYJVxAqXl0wE4DlMKQ) 

## Links for developers

* [figma file](https://www.figma.com/file/Plw8Uuu6U96CcX5tJyRMoW/Public-Transportation-visual-informaiton?node-id=0%3A1&t=EJCQpeg5zSbVXLUx-0)

* [data model schema](https://github.com/hasadna/open-bus-stride-db/blob/main/DATA_MODEL.md)

* [Slack channel](https://join.slack.com/t/hasadna/shared_invite/zt-21qipktl1-7yF4FYJVxAqXl0wE4DlMKQ)

* [Swagger](https://open-bus-stride-api.hasadna.org.il/docs)

* [Production](https://open-bus-map-search.hasadna.org.il/dashboard)

## 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](https://github.com/iliakap/open-bus-stride-client).

## Contributors

  

    

      
Shay
💻 📖 🧑‍🏫 🤔 🔬

      
Noam Gaash
📆 ⚠️ 💻 📖 👀

      
Kiril Volskiy
💻

      
R894
💻 ⚠️

      
Tamir Abutbul
💻 👀

      
aviv1620
👀 💻

      
davis0011
💻

    

    

      
Arkadi Koifman
👀

      
Ori Hoch
💻 🔣 📖 🚇 🚧 🧑‍🏫

      
israel zusha rotenberg
💻

      
Yuval
💻

      
Haswell-s
💻

      
Ori Hazan
💻

      
dorinzrihen
💻

    

    

      
Dafna Pundak
💻 👀

      
Liri S
💻 🚇 🤔

      
Etay Zaslavsky
💻

      
menachem95
💻

      
Liad Ovdat
💻

      
Amos Sidelnik
💻

    

  

### 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](https://github.com/hasadna/open-bus-stride-api).