How vedantchimote/curiositees works
Project Type and Purpose
• This is a full-stack, multi-module e-commerce application.
• Backend and Admin UI are built with Spring Boot (Java/Maven), using Spring MVC + Thymeleaf for server-side pages and REST endpoints.
• A shared library module (CuriositeesCommon) holds domain entities and exceptions.
• A separate ReactJS folder holds the customer-facing SPA code.
• Persistence is via Spring Data JPA/Hibernate against a MySQL database.
• Static file storage is used for images (user photos, brand logos, category/product images).
• CI/CD pipelines (GitHub Actions) build Docker images and publish to DockerHub; deployment target is Azure.
File Structure
• Top-level directories:
• curiositees-backend (multi-module Maven: CuriositeesCommon, CuriositeesWebParent→ CuriositeesBackend & CuriositeesFrontend)
• curiositees-frontend (ReactJS SPA)
• CuriositeesCommon: shared JAR with entity and exception classes.
• CuriositeesWebParent: parent POM for common deps, modules:
• CuriositeesBackend: Spring Boot Admin/UI + REST.
• CuriositeesFrontend: Spring Boot customer UI (Thymeleaf).
• Config & build: Maven wrappers, application.properties, Dockerfiles, docker-compose.yml.
• CI/CD: .github/workflows for backend & frontend Docker build/publish, Maven publish.
Main Components
• CuriositeesCommon Module (JAR)
• CuriositeesBackend Service & Admin UI (Spring Boot)
• CuriositeesFrontend Service & Customer UI (Spring Boot)
• ReactJS Frontend (SPA, Node or static hosting)
• MySQL Database
• File Storage (local folders under user-photos, brand-logos, category-images, product-images)
• SMTP Mail Server (for verification emails)
• CI/CD Pipeline (GitHub Actions)
• DockerHub Registry
• Azure Hosting Environment
Relationships & Data Flows
• Browser → ReactJS SPA → REST API endpoints exposed by CuriositeesBackend (or CuriositeesFrontend if customer UI is server-side)
• Admin user → Spring MVC controllers in CuriositeesBackend → Service → Repository → MySQL
• Both backend and frontend modules depend on the CuriositeesCommon library for domain models
• File uploads (user photos, logos) handled by controllers → stored in local disk folders → served as static resources
• Service layer → uses Spring Data JPA/Hibernate to read/write MySQL
• Service layer → invokes JavaMailSender (SMTP) for email notifications
• GitHub Actions → build JARs → Docker build → push images to DockerHub → Azure pull→ deploy containers
• Docker-Compose (local dev) wires CuriositeesBackend + MySQL
Architectural Patterns & Design Principles
• Layered architecture: Controller → Service → Repository
• Multi-module Maven for separation of concerns (Common, Backend, Frontend)
• MVC pattern for server-side UI (Thymeleaf)
• RESTful API for ReactJS SPA
• Shared library for DRY domain model code
• Containerization (Docker) for environment consistency
• CI/CD automation for build/test/deploy
Don’t Overthink – Capture All Components
• Every Maven module, even if it’s a simple shared library.
• Don’t omit file-storage folders – treat them as part of the persistence layer.
• Both local Docker-Compose and cloud deploy paths.