Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jpcurada/iskonnect
Team 1 - ALPHA B1T Project for COMP 20083
https://github.com/jpcurada/iskonnect
java javafx maven oop supabase
Last synced: 4 days ago
JSON representation
Team 1 - ALPHA B1T Project for COMP 20083
- Host: GitHub
- URL: https://github.com/jpcurada/iskonnect
- Owner: JpCurada
- License: mit
- Created: 2025-01-05T14:08:33.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2025-02-02T12:19:11.000Z (4 days ago)
- Last Synced: 2025-02-02T13:25:07.017Z (4 days ago)
- Topics: java, javafx, maven, oop, supabase
- Language: Java
- Homepage:
- Size: 68.5 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ISKOnnect
*Reviewers by the ISKOlars, for the ISKOlars*
[](https://www.oracle.com/java/)
[](https://openjfx.io/)
[](https://maven.apache.org/)
[](https://supabase.io/)
*Mula sa'yo, para sa bayan*
## Our Logo
The design behind our ISKOnnect logo tells its own story:
The "i" in the Middle — It's more than just a letter. Shaped like a pencil, it stands for the tools that every Iskolar uses to write, create, and learn. Simple but meaningful, just like the students who use them.
The Book/Files in the Background — Look around the "i" and you'll see books or files coming together. This shows what ISKOnnect is about — students sharing what they know, helping each other out with resources they've made themselves.
The Owl — Up at the top sits an owl, known everywhere as a symbol of wisdom. But for us PUPians, it means something more. Those tired but determined eyes? They're for every Iskolar pulling all-nighters, proving that real learning doesn't stop when the sun sets. It's a friendly nod to everyone who's ever said "one more chapter" at 3 AM.
## About ISKOnnect
ISKOnnect is a desktop application made for PUP students to help each other excel in their studies. Think of it as a digital library made by students, for students — where everyone can share reviewers, notes, and practice tests.
To make studying more fun and rewarding, we've added badges and titles that students can earn by sharing good study materials. When you start sharing, you're a "Fresh Contributor." Share more helpful reviewers and you could become a "Junior Mentor" or even reach the "PUP Hall of Famer" status.
The best part is how easy it is to find what you need. Everything is listed by college and course, so Engineering students can find Math reviewers right away, while Communication students can get writing guides quickly. Plus, students can upvote materials they find helpful, so you know which ones work best.
## System Flow
## How ISKOnnect Works
ISKOnnect showcases inheritance through several layers — but let us break down the most important ones.
First, let's look at our `User` class. Instead of creating separate user types from scratch, we built a foundation that all users share:
```java
// Path: src/main/java/com/iskonnect/models/User.java
public abstract class User {
private String strUserId;
private String strFirstName;
private String strLastName;
private String strEmail;
private String strUserType; // STUDENT or ADMIN
public String getFullName() {
return strFirstName + " " + strLastName;
}
}
```
Both students and admins need these basic details, so they inherit from this base class. It's like having a template — why write the same code twice? For example, the `Student` class adds points and badges on top of these basics, while `Admin` gets special moderation powers.
Next up is our view structure. Take a look at how both student and admin interfaces share a common layout in `base.fxml`:
```xml
```
Both student and admin views inherit this layout, but each adds its own special elements — students see their materials grid and upload options, while admins get their moderation tools. It's like having a house blueprint where you can add different furniture based on who lives there!
This approach really shows the DRY (Don't Repeat Yourself) principle in action. Instead of copy-pasting the same navigation code or user properties everywhere, we write it once and let inheritance do the heavy lifting. For instance, when we need to add a new feature to all users, we just update the parent `User` class, and both students and admins automatically get the update — pretty neat, right?
Look at the login controller — it checks the user type and sets the appropriate root:
```java
// Path: src/main/java/com/iskonnect/controllers/LoginController.java
public void handleLogin() {
if (user.getUserType().equals("ADMIN")) {
Main.setAdminRoot();
} else {
Main.setMainRoot(); // For students
}
}
```
Each type gets its own specialized view, but the underlying logic stays the same. It's like having a single front door that leads to different rooms based on who's walking in!
This inheritance setup makes our code cleaner and easier to maintain. When we want to add new features or fix bugs, we know exactly where to look — no more hunting through duplicate code or wondering which copy to update. It's all organized and connected through inheritance, just like a well-planned family tree!
## How to Use ISKOnnect
### Para sa mga Iskolar
1. Create an account using your student number
2. Look for materials in your college or course
3. Download materials you need
4. Share your own reviewers and earn rewards
5. Upvote and bookmark materials that helped you
### Para sa mga Admin
1. Check reported materials
2. Keep track of users
3. Look at how students use the app
4. Remove reported materials or ban users
## Demo
### Student View
### Contribute Reviewers
### Download Materials
### Bookmark Contents
### Report Irrelevant Materials
### Admin View
## The Team Behind ISKOnnect
### Team ALPHA B1T
- CURADA, John Paul M.(Project & Backend Lead)
- ZARAGOZA, Marie Criz (Front-End Lead)
- LUCERO, Ken Audie S. (Backend Developer)
- FAELDONIA, Elias Von Isaac R. (Front-End Java Programmer)
- OJA, Ma. Izabelle L. (Front-End Java Programmer)
- GENTE, Daisyrie I. (Designer)
- RACELIS, Michael Richmond V. (Designer)
## Setting Up ISKOnnect
1. **Check if you have these installed**
```bash
# For Java
java --version # Should be 23
# For Maven
mvn --version # Should be 3.9.9
```
2. **Get the code running**
```bash
# Get the files
git clone https://github.com/JpCurada/iskonnect.git
cd iskonnect
# Set things up
mvn clean install
```
3. **Start the app**
```bash
mvn javafx:run
```
> Contact us if you need our keys for database and storage (pa-ready gcash ^^)
## Special Thanks
- Polytechnic University of the Philippines
- PUP College of Computer and Information Sciences
- COMP 20083 Course
- Master Chris Piamonte (#CPP)
---
Gawa ng mga Iskolar, para sa kapuwa Iskolar ng Bayan!