StaffTransit API is a microservice-based backend system designed to support the StaffTransit mobile app. It provides the necessary APIs and services to enable staff members to track their staff bus, obtain real-time location updates, estimated time of arrival, and receive notifications.

• Bus Tracking: The API enables the mobile app to track the location of the staff bus in real-time.
• Estimated Time of Arrival: It provides estimated time of arrival to bus stops based on the bus's current location and traffic conditions.
• Notification System: The API includes a notification service to send updates and notifications to app users regarding bus status and relevant information.

The StaffTransit API project utilizes the following technologies:

• Backend Languages:

  • Node.js with TypeScript
  • Golang

• Messaging Queue:

  • RabbitMQ

To run the StaffTransit API locally, follow these steps:

1. Clone the StaffTransit-Services repository from GitHub:

   git clone https://github.com/charles0007/StaffTransit-Services.git
   

2. Navigate to the API project directory:

   cd StaffTransit-Services/api
   

3. Install the dependencies by running the following command:

   npm install
   

4. Start the API server:

   npm start
   

   The API server will now be running locally on the specified port.

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).

We welcome contributions to the StaffTransit project. If you would like to contribute, please follow the guidelines outlined in the CONTRIBUTING file.

If you encounter any issues, have suggestions, or need assistance with the StaffTransit API, please open an issue on the GitHub repository. We appreciate your feedback and will do our best to assist you.

StaffTransit API 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 information.