souptik-mu/fsp_project

Purpose and Entry Points

This is a full-stack PG (paying-guest accommodation) discovery and management system. The Spring Boot backend exposes domain APIs for authentication, PG listings, amenities, reviews, favorites, search, recommendations, users, and administration. The Vite/React frontend currently has a minimal single-page entry and home page.

• Backend bootstrap: backend/src/main/java/com/example/backend/BackendApplication.java

• Frontend bootstrap: frontend/src/main.jsx, frontend/src/App.jsx

• Initial UI route/content: frontend/src/pages/Home.jsx

HTTP/API Layer

Controllers form the backend’s external boundary and route client requests into domain services. Separate controllers indicate distinct API surfaces for identity, listing lifecycle, user interactions, discovery, and administrative operations.

• Listing APIs: backend/src/main/java/com/example/backend/controllers/PGController.java

• Identity/admin APIs: backend/src/main/java/com/example/backend/controllers/AuthController.java, backend/src/main/java/com/example/backend/controllers/AdminController.java

• Discovery/engagement APIs: backend/src/main/java/com/example/backend/controllers/SearchController.java, backend/src/main/java/com/example/backend/controllers/RecommendationController.java, backend/src/main/java/com/example/backend/controllers/FavouriteController.java

Core Accommodation Domain

PG is the central persisted listing entity. Its associated amenity mapping, user favorites, and reviews model the primary tenant-facing listing experience. Request/response DTOs establish an API boundary around listing mutation and representation.

• Core entities: backend/src/main/java/com/example/backend/entity/PG.java, backend/src/main/java/com/example/backend/entity/PGAmenity.java, backend/src/main/java/com/example/backend/entity/Amenity.java

• Listing API models: backend/src/main/java/com/example/backend/DTO/request/CreatePG.java, backend/src/main/java/com/example/backend/DTO/request/UpdatePG.java, backend/src/main/java/com/example/backend/DTO/response/PGResponse.java

• Listing orchestration: backend/src/main/java/com/example/backend/service/PGService.java

Identity and Authorization Domain

Users have persisted identity and role state; authentication logic is isolated behind a service and controller. Role, gender, food, and room-type enums constrain key business attributes rather than leaving them as unrestricted values.

• Identity components: backend/src/main/java/com/example/backend/entity/User.java, backend/src/main/java/com/example/backend/service/AuthService.java, backend/src/main/java/com/example/backend/service/UserService.java

• Authorization/domain enums: backend/src/main/java/com/example/backend/enums/Role.java, backend/src/main/java/com/example/backend/enums/Gender.java

• User response boundary: backend/src/main/java/com/example/backend/DTO/response/UserResponse.java

Engagement and Discovery Flow

A typical consumer flow is: authenticate or identify a user; search/browse PGs; retrieve recommendations; inspect amenity details and reviews; then create or remove favorites. Controllers delegate to services, which access repositories for persistence.

• Engagement records/services: backend/src/main/java/com/example/backend/entity/Favorite.java, backend/src/main/java/com/example/backend/entity/Review.java, backend/src/main/java/com/example/backend/service/FavouriteService.java

• Discovery endpoints: backend/src/main/java/com/example/backend/controllers/SearchController.java, backend/src/main/java/com/example/backend/controllers/RecommendationController.java

• Review handling: backend/src/main/java/com/example/backend/controllers/ReviewController.java, backend/src/main/java/com/example/backend/service/ReviewService.java

Persistence Boundary

Spring Data-style repository interfaces isolate database access from services. The object model covers users, listings, amenities and their associations, reviews, and favorites.

• Principal repositories: backend/src/main/java/com/example/backend/repository/PGRepository.java, backend/src/main/java/com/example/backend/repository/UserRepository.java, backend/src/main/java/com/example/backend/repository/ReviewRepository.java

• Relationship repositories: backend/src/main/java/com/example/backend/repository/PGAmenityRepository.java, backend/src/main/java/com/example/backend/repository/FavouriteRepository.java

Runtime and Infrastructure

The backend is a Maven-managed Java/Spring Boot process, configured through application properties; its database/provider and authentication mechanism cannot be determined from the supplied tree. The frontend is a Node-based Vite React application and is expected to communicate with backend HTTP endpoints.

• Backend build/runtime configuration: backend/pom.xml, backend/src/main/resources/application.properties

• Frontend runtime/build configuration: frontend/package.json, frontend/vite.config.js