StaffTransit
StaffTransit is a mobile app designed to assist staff members in tracking their staff bus. With this app, users can easily track the location of the bus, get an estimated time of arrival to their bus stop, and receive notifications regarding bus status updates.
Features
- Real-time bus tracking: Users can view the current location of the staff bus on a map within the app.
- Estimated time of arrival: The app provides an estimated time of arrival for the bus to the user's designated bus stop.
- Notifications: Users receive notifications regarding any updates or changes related to the bus schedule or status.
Technology Stack
The StaffTransit project utilizes the following technologies:
-
Mobile App:
- Framework: Flutter (Dart)
- Source Code: https://github.com/charles0007/StaffTransit-MobileApp
-
Microservices:
- Backend: Node.js (TypeScript) and Golang
- API Repository: https://github.com/charles0007/StaffTransit-Services
- Event Bus: RabbitMQ
How to Run the Flutter App
To run the Flutter app locally, follow these steps:
-
Ensure you have Flutter SDK installed on your machine. If not, refer to the official Flutter documentation for installation instructions.
-
Clone the StaffTransit-MobileApp repository from GitHub:
git clone https://github.com/charles0007/StaffTransit-MobileApp.git
-
Open the project directory in your preferred code editor.
-
Run the following command to fetch the project dependencies:
flutter pub get
-
Connect your Android or iOS device or start an emulator/simulator.
-
Run the app using the following command:
flutter run
This command will build and install the app on the connected device or emulator/simulator.
How to Pull from the Git Repository
To pull the latest changes from the StaffTransit-Services repository, execute the following command:
git pull origin main
This command will fetch and merge the latest changes from the remote repository (origin) into your local branch (main).
License
StaffTransit is licensed under the GNU General Public License 2.0 (GPL-2.0). Please see the LICENSE file for more details.
Feel free to reach out if you have any further questions or need additional assistance.
Certainly! Here's the continuation of the readme:
Contributing
We welcome contributions to the StaffTransit project. If you would like to contribute, please follow these steps:
-
Fork the repository from https://github.com/charles0007/StaffTransit-Services to your GitHub account.
-
Clone the forked repository to your local machine:
git clone https://github.com/charles0007/StaffTransit-Services.git
-
Create a new branch for your contribution:
git checkout -b your-branch-name
-
Make the necessary changes and additions to the codebase.
-
Test your changes thoroughly to ensure they work as expected.
-
Commit your changes with descriptive commit messages:
git commit -m "Add feature X"
-
Push your changes to your forked repository:
git push origin main
-
Open a pull request on the original repository at https://github.com/charles0007/StaffTransit-Services and provide a detailed description of your contribution.
-
Wait for the project maintainers to review your pull request. Be prepared to make any necessary changes or address any feedback received.
Feedback and Support
If you encounter any issues, have suggestions, or need assistance with the StaffTransit project, please open an issue on the respective GitHub repositories (Mobile App or Services). We appreciate your feedback and will do our best to assist you.
License
StaffTransit is licensed under the GNU General Public License 2.0 (GPL-2.0). Please see the LICENSE file for more details.
Please feel free to reach out if you have any further questions or need additional information.