HALL DINNING REVIEW SYSTEM (JAVA PROJECT - DESKTOP APPLICATION)

Table of Contents

• Description
• User Interface
• Installation
• How to Run
• Documentation
• Contributing
• License

Description

“Hall Dining Review” is a desktop app that will help a user to share his experience about hall dining. There is a problem that all hall boarders can’t give feedback to the dining manager. So, it is impossible for dining manager to upgrade or add any item to dining. This app will help both students and dining manager to communicate in an easy way in one platform! Hall administrators also get a summary of student reaction about hall dining…

User Interface

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

---

Installation

1. Install MySQL

First, install and set up MySQL Server:

sudo apt install mysql-server
sudo systemctl start mysql.service
sudo mysql

Set the root password:

sudo mysql -u root -p
ALTER USER 'root'@'localhost' IDENTIFIED WITH mysql_native_password BY 'password';
exit

2. Create the Database

Access MySQL again to create and configure the database:

sudo mysql -u root -p
> Enter Password: password

Now, create the database dms and use it:

> create database dms;
> use dms;
> show tables;

3. Project Setup

1. Install Netbeans IDE from here.

2. Clone the project repository and open it in NetBeans:

   git clone https://github.com/Sk-Azraf-Sami/Hall-Dinning-Review-System.git

   1. Open the project in NetBeans.
   2. Navigate to Source Packages -> dao -> tables.java.
   3. Run the file by pressing Shift+F6.

4. Verify Database Tables

After running the application, go back to MySQL and verify the created tables:

> show tables;

How to Run

1. Open a terminal and navigate to the Hall-Dinning-Review-System project directory:

   cd Hall-Dinning-Review-System

2. Go to the dist folder:

   cd dist

3. Run the application using the following command:

   java -jar "Review_on_Hall_Dining.jar"

Additional Notes

• If you encounter any issues during installation, please check the repository's issues section for solutions or to report a problem.
• Be sure to check for updates regularly to keep this desktop application running smoothly.

Documentation

For detailed information about the 'Hall-Dinning-Review-Desktop-Application', please refer to the docummentation.

Contributing

Thank you for your interest in contributing to the 'Hall-Dinning-Review-Desktop-Application'! We welcome contributions from everyone. To get started, please follow the guidelines below:

Bug Reports and Feature Requests

If you encounter any bugs or have ideas for new features, please open an issue on the GitHub repository. When opening an issue, provide as much detail as possible, including steps to reproduce the issue and any relevant information about your environment. This will help us investigate and address the problem more effectively.

Pull Requests

We gladly accept pull requests for bug fixes, enhancements, and new features. To contribute code to the project, follow these steps:

1. Fork the repository and create your branch from the main branch.
2. Make your changes, ensuring that your code adheres to the project's coding style and conventions.
3. Write tests to cover your changes and ensure the existing tests pass.
4. Ensure your code compiles without any errors or warnings.
5. Commit your changes and push your branch to your forked repository.
6. Open a pull request against the main branch of the original repository.
7. Provide a clear and descriptive title for your pull request and explain the changes you have made.
8. Be responsive to any feedback or questions during the review process.

By contributing to this project, you agree that your contributions will be licensed under the project's MIT License.

Code Style and Conventions

To maintain consistency throughout the project's codebase, please adhere to the following guidelines:

• Use proper indentation and formatting.
• Follow naming conventions for variables, classes, and methods.
• Write clear and concise comments to improve code readability.
• Ensure your code is modular, reusable, and follows best practices.

Communication

If you have any questions or need assistance, feel free to reach out to the project maintainers or open an issue on GitHub.

We appreciate your contributions and look forward to working with you to improve desktop application!

License

This project is licensed under the MIT License.