Realtime Bus Board

This project is a realtime bus framework based on React, designed to provide a customizable and extensible platform for displaying public transportation data.

English | 中文

Features

• Realtime data: The framework uses public transportation data APIs to provide the latest realtime bus data.
• Extensibility: The framework is easy to extend, allowing you to add new bus data sources or modify existing ones.
• Customizability: You can customize the styles of bus stops and maps to meet your needs.

Example

Yantai Bus board

Requirements

• Node.js

Quick Start

1. Clone the repository

git clone git@github.com:Gavinin/RealtimeBusBoard.git

2. Install dependencies

cd Realtime-Bus-Framework/src
npm install

3. Change Config in custom folder Please view How to custom config file
4. Run the project

npm start

5. View the project in your browser

Open http://localhost:3000 in your browser to view the realtime bus framework.

How to Contribute

If you would like to contribute to this project, you can follow these steps:

1. Clone the repository

git clone https://github.com/Gavinin/Realtime-Bus-Framework.git

2. Create branch

git checkout -b feature/your-feature

3. Change code and push

git add .
git commit -m "Add your commit message here"
git push origin feature/your-feature

4. Submit the pull request

Open a Pull request on github to describe the changes you make.

License

This project is licensed under the MIT License. See the LICENSE.md file for details.