Crayfish Sales System

Functionality

• Information management: includes management of boss-employee and employee-warehouse information.
• This project is for learning and communication purposes only. It is strictly prohibited for any commercial use or illegal activities.
• This project follows the CC4.0 BY-SA Creative Commons license. Users are required to clone or use this project in accordance with the license agreement.

Project Repository

• Repository: https://github.com/Crysta1PEER/Crayfish_sales_system
• If you like the project, please consider giving us a star on GitHub. We greatly appreciate your support!

---

Environment and Dependencies

• This project relies on the following third-party software. Please ensure that all necessary dependencies are installed before running the project.
• Git: We recommend installing Git if you intend to clone the project from platforms like GitHub or Gitee.
• Download link: https://git-scm.com/download
• MySQL Environment: Please be aware that the project you are running utilizes MySQL services. Make sure to set up the necessary environment on your personal computer.
• Java Environment: The project code primarily uses Java statements. To run the project successfully, you must have Java environment properly set up.
• JDBC Driver: Since this project involves connecting Java with MySQL, please prepare the JDBC driver in advance.

---

Installation and Usage

• Before using the project, clone it to your local machine.

• Here, we provide two ways to obtain the installation package. Choose the method you prefer.

  • Clone from GitHub: Execute the following code:

    git clone https://github.com/Crysta1PEER/Crayfish_sales_system
    

    This method may not be user-friendly for users within mainland China but allows you to receive updates promptly. To synchronize the repository, run git pull in the project's root directory.
  • Contact Us: If you can easily get in touch with us, we can provide you with a .zip file named "Crayfish_sales_system_master". You can obtain the project by extracting the contents from the compressed file. However, note that you will only have a local copy of the project and won't be able to receive updates via Git.

• Once you have completed the above steps, you can run the project using your preferred method, such as the command line.

---

Features

• As the name suggests, this project is an information management application. The main functionality is achieved by using JDBC to interact with MySQL and perform CRUD operations.

• In this system, we have defined two roles: employee and boss (administrator), each with different usage scenarios:

  • Employees can manage warehouse information.
  • The boss can manage both employee and warehouse information.

• This project displays menus and information in the console using character-based output. It allows users to interact by inputting specific keys to perform data management operations, which is more user-friendly compared to pure code-based operations.

---

Examples and Sample Code

• You are allowed to modify the code to better suit your specific use case.
• Code examples are not provided here. You can obtain the program source code by cloning the project or using the installation package we provided.

---

Contribution Guidelines

• We welcome users and developers to contribute to this repository by submitting issues or pull requests.
• Regarding submitting issues, we recommend following these steps before creating a new issue:
  • Check if someone else has already reported a similar issue.
  • Search the issue using a search engine.
  • Make sure your device meets the system requirements.
• When submitting an issue, please:
  • Describe the problem you encountered.

Specify the device you used to run the project (including detailed system information).

• Provide screenshots, steps to reproduce, or any other relevant information.

• After you submit an issue, we will do our best to resolve it as soon as possible. However, this is subject to our personal lives and the complexity of the implementation. Please understand.

• Regarding pull requests:

  • Make sure the code you submit runs properly and integrates well with the project.
  • Clearly state the functionality and system requirements of your code.
  • Ensure that the code you submit complies with the GitHub community guidelines and the laws of the People's Republic of China.

• After you submit a pull request, we will review your code as soon as possible. However, this is subject to our personal lives and the complexity of the implementation. Please understand.

---

Version History

• The project started with a "Hello World" and was our first collaborative project.

• The following is information about the version history, recording the birth of each star.

• 0.0.1r230526: After a cold winter, the fragrance of plum blossoms spreads. After a semester, we finally started applying the knowledge we learned and wrote the first line of code for the project. A new folder, a new tree sprouting.

• 0.0.2r230528: On the first Sunday after starting the project, we chose today to build the overall structure of the project. The beginning is always difficult, but we search for flowers from afar.

• 0.0.3r230602: Further improvements were made to the project, and MySQL integration began. Leaving traces in a new world, paying tribute to the old era.

• 0.0.4r230603: Addressed accumulated issues in the project and optimized code structure. Remove labels, avoid being defined.

• 0.0.5r230603: Inserted test data and successfully ran the project. Taking the first step in our own world.

• 0.0.6r230604: Further improved the code and tested the GUI interface. A dual journey of internal and external exploration.

• 0.0.7r230605: Fixed some bugs and optimized the text interface. Presentation materials, such as PowerPoint, are ready — all is prepared, only awaiting the east wind.

• 0.0.8r230609: Temporarily decided to abandon the GUI interface. Compromising for practicality, avoiding excessive bugs — you can't have both the fish and the bear's paw.

• 0.0.9r230609: Uploaded the project to the repository and wrote the readme.md. Writing our own story, offering blessings to a better world.

• 0.1BETA: As the eaglet opens its eyes at this moment, a new bud emerges from the soil. Just as new life is born, our project sets sail. Even if it is full of flaws, we will continue to work hard to give it a complete and pure soul.

---

Authors and Contributors

• Project Author:

  • Yifan Shen (HNNU)

• Project Contributors:

  • Weitao (HNNU, GitHub: @Crysta1PEER)
  • Qingyao Wang (HNNU)
  • Ruiyang Wu (HNNU)

• Advising Professors:

  • Carter (HNNU)
  • Nawaid (NIIT)

• Special Thanks:

  • You, for showing interest in this project (❤️)

• We sincerely thank each participant and advising professor for their contributions to this project!

---