GiveAgo is a delivery platform designed to facilitate the efficient and organized delivery of packages for businesses. With GiveAgo, business owners can easily order couriers to deliver goods to their customers, ensuring timely and hassle-free deliveries.
-
Easy Order Placement: The platform provides a user-friendly interface for businesses to place delivery orders conveniently.
-
Courier Assignment: GiveAgo has a robust system for assigning the most suitable courier to each delivery order based on factors such as location, availability, and past performance.
-
Real-Time Tracking: Customers can track the progress of their deliveries in real-time using the GiveAgo platform. This feature enhances transparency and allows customers to stay informed about the status of their packages.
-
Delivery Notifications: GiveAgo sends automated notifications to both businesses and customers to keep them updated about important delivery milestones, such as pickup, transit, and delivery.
To use GiveAgo, follow these steps:
-
Clone the repository: git clone https://github.com/etamarh12/GiveAgo.git
-
Install the required dependencies: cd GiveAgo npm install
-
Set up the database:
- Create a new database for GiveAgo in your preferred database management system MySQL
- Configure the database connection by updating the
config/database.js
file with your database credentials.
- Set up environment variables:
- Rename the
.env.example
file to.env
. - Open the
.env
file and update the necessary environment variables, such as database credentials, API keys, and other configuration options.
-
Start the application: npm start
-
Access GiveAgo: Open your web browser and visit
http://localhost:3000
to access the GiveAgo platform.
We welcome contributions from the community to enhance GiveAgo's functionality and address any issues. To contribute, please follow these guidelines:
-
Fork the repository.
-
Create a new branch for your feature or bug fix: git checkout -b feature/new-feature or git checkout -b bug/issue-fix
-
Make your modifications and commit the changes.
-
Push your branch to your forked repository.
-
Create a pull request to the main repository's
develop
branch, outlining the changes you have made.
This project is licensed under the MIT License.
If you have any questions or suggestions, please feel free to reach out to me on LinkedIn. I appreciate your feedback!