https://github.com/altech001/group_cw_hci
https://github.com/altech001/group_cw_hci
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/altech001/group_cw_hci
- Owner: Altech001
- Created: 2025-05-16T14:55:55.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-24T10:44:55.000Z (about 1 year ago)
- Last Synced: 2025-05-24T11:33:55.633Z (about 1 year ago)
- Language: Java
- Size: 1.05 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
GROUP_CW_HCI.GIT
VU Library MS
❯ REPLACE-ME
Table of Contents
- [📍 Overview](#-overview)
- [👾 Features](#-features)
- [📁 Project Structure](#-project-structure)
- [📂 Project Index](#-project-index)
- [🚀 Getting Started](#-getting-started)
- [☑️ Prerequisites](#-prerequisites)
- [⚙️ Installation](#-installation)
- [🤖 Usage](#🤖-usage)
- [🧪 Testing](#🧪-testing)
- [📌 Project Roadmap](#-project-roadmap)
- [🔰 Contributing](#-contributing)
- [🎗 License](#-license)
- [🙌 Acknowledgments](#-acknowledgments)
## 📍 Overview
❯ REPLACE-ME
---
## 👾 Features
❯ REPLACE-ME
---
## 📁 Project Structure
```sh
└── Group_CW_HCI.git/
├── LibraryManager.zip
├── README.md
├── data
│ ├── books.ser
│ ├── fines.ser
│ ├── loans.ser
│ └── users.ser
├── pom.xml
├── src
│ └── main
└── target
├── classes
└── maven-status
```
### 📂 Project Index
GROUP_CW_HCI.GIT/
__root__
target
maven-status
maven-compiler-plugin
compile
default-compile
inputFiles.lst
❯ REPLACE-ME
createdFiles.lst
❯ REPLACE-ME
src
main
java
Main.java
❯ REPLACE-ME
luco
sms
librarymanager
LibraryManager.java
❯ REPLACE-ME
controllers
BookController.java
❯ REPLACE-ME
AuthController.java
❯ REPLACE-ME
LibrarySystem.java
❯ REPLACE-ME
UserController.java
❯ REPLACE-ME
LoanController.java
❯ REPLACE-ME
models
Librarian.java
❯ REPLACE-ME
Borrower.java
❯ REPLACE-ME
Loan.java
❯ REPLACE-ME
Clerk.java
❯ REPLACE-ME
User.java
❯ REPLACE-ME
Fine.java
❯ REPLACE-ME
Book.java
❯ REPLACE-ME
utils
FileHandler.java
❯ REPLACE-ME
IconUtils.java
❯ REPLACE-ME
Constants.java
❯ REPLACE-ME
ValidationUtils.java
❯ REPLACE-ME
ui
LibrarianPanel.java
❯ REPLACE-ME
BorrowerPanel.java
❯ REPLACE-ME
LoginPanel.java
❯ REPLACE-ME
LibraryUI.java
❯ REPLACE-ME
ClerkPanel.java
❯ REPLACE-ME
components
LoanManagementPanel.java
❯ REPLACE-ME
LoanHistoryPanel.java
❯ REPLACE-ME
UserManagementPanel.java
❯ REPLACE-ME
BookManagementPanel.java
❯ REPLACE-ME
BookSearchPanel.java
❯ REPLACE-ME
FineManagementPanel.java
❯ REPLACE-ME
---
## 🚀 Getting Started
### ☑️ Prerequisites
Before getting started with Group_CW_HCI.git, ensure your runtime environment meets the following requirements:
- **Programming Language:** Java
### ⚙️ Installation
Install Group_CW_HCI.git using one of the following methods:
**Build from source:**
1. Clone the Group_CW_HCI.git repository:
```sh
❯ git clone https://github.com/Altech001/Group_CW_HCI.git
```
2. Navigate to the project directory:
```sh
❯ cd Group_CW_HCI.git
```
3. Install the project dependencies:
echo 'INSERT-INSTALL-COMMAND-HERE'
### 🤖 Usage
Run Group_CW_HCI.git using the following command:
echo 'INSERT-RUN-COMMAND-HERE'
### 🧪 Testing
Run the test suite using the following command:
echo 'INSERT-TEST-COMMAND-HERE'
---
## 📌 Project Roadmap
- [X] **`Task 1`**: Implement feature one.
- [ ] **`Task 2`**: Implement feature two.
- [ ] **`Task 3`**: Implement feature three.
---
## 🔰 Contributing
- **💬 [Join the Discussions](https://github.com/Altech001/Group_CW_HCI.git/discussions)**: Share your insights, provide feedback, or ask questions.
- **🐛 [Report Issues](https://github.com/Altech001/Group_CW_HCI.git/issues)**: Submit bugs found or log feature requests for the `Group_CW_HCI.git` project.
- **💡 [Submit Pull Requests](https://github.com/Altech001/Group_CW_HCI.git/blob/main/CONTRIBUTING.md)**: Review open PRs, and submit your own PRs.
Contributing Guidelines
1. **Fork the Repository**: Start by forking the project repository to your github account.
2. **Clone Locally**: Clone the forked repository to your local machine using a git client.
```sh
git clone https://github.com/Altech001/Group_CW_HCI.git
```
3. **Create a New Branch**: Always work on a new branch, giving it a descriptive name.
```sh
git checkout -b new-feature-x
```
4. **Make Your Changes**: Develop and test your changes locally.
5. **Commit Your Changes**: Commit with a clear message describing your updates.
```sh
git commit -m 'Implemented new feature x.'
```
6. **Push to github**: Push the changes to your forked repository.
```sh
git push origin new-feature-x
```
7. **Submit a Pull Request**: Create a PR against the original project repository. Clearly describe the changes and their motivations.
8. **Review**: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!
Contributor Graph
---
## 🎗 License
This project is protected under the [SELECT-A-LICENSE](https://choosealicense.com/licenses) License. For more details, refer to the [LICENSE](https://choosealicense.com/licenses/) file.
---
## 🙌 Acknowledgments
- List any resources, contributors, inspiration, etc. here.
- [X] **`Albert`**: Implement feature one.
- [x] **`Disan`**: Implement feature two.
- [x] **`Queen`**: Implement feature three.
- [x] **`Samuel`**: Implement feature Four.
- [ ] **`Andrew`**: Implement feature five.
- [ ] **`Gorila`**: Implement feature six.
---