HouseHub – Code Directory README


This directory contains all source code, deployable artifacts, database scripts,
and documentation required to install, run, and use the HouseHub Capstone project.


Directory Structure


Code/
│
├── Backend/
│   Contains the Spring Boot backend application implemented in Java.
│   Includes REST APIs, authentication, authorization, database access,
│   and business logic for the HouseHub system.
│
├── Frontend/
│   Contains the React + Vite frontend application written in TypeScript.
│   This directory includes all UI components, pages, styles, and
│   configuration files needed to run the web client.
│
├── Database/
│   Contains PostgreSQL SQL scripts used to recreate the database schema
│   and populate the database with sample or current data.
│
│   - househub_schema.sql: Creates all database tables, relationships,
│     constraints, and indexes.
│   - househub_data.sql (optional): Inserts sample or current data.
│
├── Installation_Guide.pdf
│   Provides step-by-step instructions (with screenshots) for installing
│   and configuring the project, including PostgreSQL, backend, and frontend.
│
├── User_Manual.pdf
│   Describes how end users interact with the HouseHub system, including
│   account creation, chore management, payments, messaging, and notifications.


Technologies Used
Backend:
- Java 21
- Spring Boot 3.x
- Spring Security with JWT
- JPA / Hibernate
- PostgreSQL

Frontend:
- React
- TypeScript
- Vite
- Chakra UI

Database:
- PostgreSQL


Notes


- All database scripts are located in the Database directory.
- Environment-specific configuration values (such as database credentials)
  must be updated in the backend configuration files as described in the
  Installation Guide.
- This repository contains no private credentials or sensitive information.


End of README

