Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shubh2-0/shipmentxpress
A robust Java-based shipment management system that empowers seamless package handling. Effortlessly manage shipments, from creation to updates and deletions, ensuring reliable delivery logistics.
https://github.com/shubh2-0/shipmentxpress
hibernate java-8 lombok maven mysql-database
Last synced: 4 days ago
JSON representation
A robust Java-based shipment management system that empowers seamless package handling. Effortlessly manage shipments, from creation to updates and deletions, ensuring reliable delivery logistics.
- Host: GitHub
- URL: https://github.com/shubh2-0/shipmentxpress
- Owner: Shubh2-0
- Created: 2023-08-15T20:13:01.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-18T18:53:31.000Z (10 months ago)
- Last Synced: 2024-05-01T13:47:22.928Z (7 months ago)
- Topics: hibernate, java-8, lombok, maven, mysql-database
- Language: HTML
- Homepage:
- Size: 1.52 MB
- Stars: 12
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ShipmentXpress :truck:
ShipmentXpress is a powerful Java-based shipment management system designed to streamline the end-to-end process of handling shipments. From creating new shipments and tracking existing ones to updating details and retrieving information, ShipmentXpress offers a user-friendly interface for efficient shipment management. With features such as CRUD operations, intuitive tracking, and comprehensive documentation, ShipmentXpress simplifies the complexities of logistics, enabling businesses to focus on delivering exceptional service.
## Table of Contents
- :rocket: Features
- :book: Javadoc
- 🛠️ Tools Used (Tech Stack)
- :gear: Getting Started
- :wrench: Prerequisites
- :computer: Installation
- :hammer_and_wrench: Usage
- :raised_hands: Contributing
- :email: Contact
## :rocket: Features
- Add new shipments with details like package number, content, weight, sender, and recipient addresses.
- Delete shipments by their unique IDs.
- Update shipment details, including content, weight, and recipient address.
- Retrieve shipments by ID, sender address, weight range, or creation date range.
## :book: Javadoc
Explore the comprehensive documentation of the ShipmentXpress project by visiting the Javadoc website: [Javadoc website](https://shipmentxpress.netlify.app/).
## Tools Used 🛠️
Java
Hibernate
MySQL
Maven
Lombok
STS
GitHub
## :gear: Getting Started
### :wrench: Prerequisites
Before you begin, make sure you have the necessary tools and components:
- Java JDK (version 8 or higher)
- MySQL database
- Maven
### :computer: Installation
Follow these steps to install and set up ShipmentXpress:
1. Clone the repository:
git clone https://github.com/Shubh2-0/ShipmentXpress.git
cd ShipmentXpress
2. Configure database settings:
Update the persistence.xml file located in the src/main/resources/META-INF directory with your MySQL database details.
3. Build the project:
mvn clean install
## :hammer_and_wrench: Usage
To use ShipmentXpress:
1. Run the application:
java -jar target/ShipmentXpress.jar
2. To see a simple usage example of interacting with the ShipmentXpress functionalities, you can refer to the ShipmentXpressTest class. This class demonstrates how to create, retrieve, update, and delete shipments. You can modify the example according to your project's design and data.
## :raised_hands: Contributing
We welcome contributions from the community! Here's how you can contribute:
1. Fork the repository.
2. Create a new branch for your feature or bug fix: git checkout -b feature-name.
3. Make your changes and commit them: git commit -m "Add some feature".
4. Push to the branch: git push origin feature-name.
5. Create a pull request explaining your changes.
## 📬 Contact
If you want to contact me, you can reach me through below handles.
