MCPcopy Index your code
hub / github.com/Jubilee101/SweetHome

github.com/Jubilee101/SweetHome @main

Chat with this repo
repository ↗ · DeepWiki ↗ · + Follow
327 symbols 610 edges 68 files 0 documented · 0%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

SweetHome

SweetHome is a property management system for managers and residents to better communicate with one another DashBoardPage

Notice

(10/05/2023) I'm getting a question on setting up the project (sorry for seeing that 1 month later). I'm sorry but the project was never properly packaged and released. The database in this project was hosted on an Amazon RDS server. I deliberately left out the configuration of that part for safety reason. So in order to make the project to work you'll need to launch an RDS instance and configure properly. You will also want to connect to google cloud storage since that's where the images are stored. Then you can run the backend in a proper IDE such as Intellij locally. I'm pretty occupied right now and probably won't have time to setup a wiki any time soon. But if you'd like you can leave your email in my form and I'll reach out. Thank you for liking my project.

Current Features

  1. Invoice dashboard with long polling listening to backend for any public/personal invoice update
  2. Quick and simple maintenance request sending/handling and public utils reservation/cancellation
  3. Discussion board that supports live chat and infinite scrolling!

See video demo here:

SweetHome Demo

Updates

We now support canceling public utils on the resident side! No more worries that you accidentally clicked something! CancelReservation

Tools and Frameworks

SweetHome mainly uses Spring Boot to build its backend and React.js for the frontend. It also utilized GCS to store images. Spring Data JPA is used for better and easier database manipulation.

Notice

This is the backend implementation of SweetHome, please see frontend here :)

Extension points exported contracts — how you extend this code

MessageRepository (Interface)
(no doc) [1 implementers]
src/main/java/com/hzhang/sweethome/repository/MessageRepository.java
MaintenanceReservationRepository (Interface)
(no doc)
src/main/java/com/hzhang/sweethome/repository/MaintenanceReservationRepository.java
AuthorityRepository (Interface)
(no doc)
src/main/java/com/hzhang/sweethome/repository/AuthorityRepository.java
PublicUtilsRepository (Interface)
(no doc)
src/main/java/com/hzhang/sweethome/repository/PublicUtilsRepository.java
Public_invoicesRepository (Interface)
(no doc)
src/main/java/com/hzhang/sweethome/repository/Public_invoicesRepository.java

Core symbols most depended-on inside this repo

getDate
called by 18
src/main/java/com/hzhang/sweethome/model/Message.java
build
called by 16
src/main/java/com/hzhang/sweethome/model/User.java
save
called by 12
src/main/java/com/hzhang/sweethome/service/ImageStorageService.java
getName
called by 12
src/main/java/com/hzhang/sweethome/model/User.java
setEmail
called by 10
src/main/java/com/hzhang/sweethome/model/User.java
getEmail
called by 8
src/main/java/com/hzhang/sweethome/model/User.java
add
called by 6
src/main/java/com/hzhang/sweethome/controller/MessageController.java
parse
called by 6
src/main/java/com/hzhang/sweethome/service/PublicUtilsReservationService.java

Shape

Method 253
Class 62
Interface 9
Enum 3

Languages

Java100%

Modules by API surface

src/main/java/com/hzhang/sweethome/model/MaintenanceReservation.java21 symbols
src/main/java/com/hzhang/sweethome/model/User.java16 symbols
src/main/java/com/hzhang/sweethome/model/PersonalInvoice.java15 symbols
src/main/java/com/hzhang/sweethome/model/Message.java13 symbols
src/main/java/com/hzhang/sweethome/model/Public_invoices.java12 symbols
src/main/java/com/hzhang/sweethome/model/PublicUtilsReservation.java12 symbols
src/main/java/com/hzhang/sweethome/service/MaintenanceReservationService.java10 symbols
src/main/java/com/hzhang/sweethome/service/PublicUtilsReservationService.java9 symbols
src/main/java/com/hzhang/sweethome/model/UnreadNumKey.java9 symbols
src/main/java/com/hzhang/sweethome/controller/CustomExceptionHandler.java8 symbols
src/main/java/com/hzhang/sweethome/service/UnreadNumService.java7 symbols
src/main/java/com/hzhang/sweethome/controller/PublicUtilsReservationController.java7 symbols

For agents

$ claude mcp add SweetHome \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact