Skip to content

EldonLim/StudySync-Software-Engineering-Project-

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

2006-SCSE-R2

StudySync is a gamified virtual study platform built as part of our SC2006 Software Engineering course. It empowers students to stay productive and accountable through shared study rooms, timers, personalized avatars, and community features.


📺 Demo Video

Watch our walkthrough/demo of StudySync here:

🔗 YouTube Demo Link: https://youtu.be/8O4kGaiI4k4?si=-mlG7t81Iw-zBsfj


🚀 Tech Stack

  • Frontend: Flutter
  • Backend: Python (self-hosted)
  • Database: Firebase
  • Tunnel & Hosting: Cloudflare Tunnel

🧱 Architecture

We adopted the Model-View-ViewModel (MVVM) architecture for building the frontend in Flutter.

MVVM Components

  • Model: Logic and data management handled via repositories connected to Firebase
  • View: UI components built with Flutter widgets
  • ViewModel: Acts as the bridge between UI and data; handles business logic and state management using Provider

Benefits

  • Separation of concerns
  • Improved testability and scalability
  • Cleaner code organization and easier maintenance

📱 Running the App (Frontend Setup)

1. Prerequisites

  • Flutter SDK
  • An Android/iOS emulator or a physical device connected via USB

2. Firebase Configuration

Before running the app, you need to:

  • Contact me with your device's SHA-1 or SHA-256 certificate fingerprint
  • I will whitelist your device in Firebase

3. Running the App

flutter pub get
flutter run

🌐 Backend Info

  • The backend is already deployed and publicly accessible.
  • All API endpoints are exposed via Cloudflare Tunnel, so no additional setup is required on your side.

🛠 Features

  • 🎯 Focus Timer in Virtual Rooms

  • 🧑‍🤝‍🧑 Avatar-based Study Environment

  • 🗓️ Google Calendar Integration

  • 🧠 AI Task Suggestions

  • 👥 Join Study Communities & Rooms

  • 📊 Productivity Insights & Stats

🙋 Contact

For setup or collaboration: Eldon Lim Kai Jie

Email: eldo0001@e.ntu.edu.sg

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published