DomiCare - Professional Cleaning & Maintenance Platform

A modern, transparent, and secure platform connecting customers with professional cleaning and maintenance services.

---

📑 Table of Contents

• Introduction
• Key Features
• System Architecture
• Technology Stack
• Database Structure
• Installation Guide
• Quick Start
• Deployment Process
• API Documentation
• Security
• Demo
• Contributing
• Contact
• License

---

🌟 Introduction

DomiCare is a web-based platform designed to streamline the booking of professional cleaning and maintenance services. Built with modern technologies like Spring Boot and ReactJS, it ensures a seamless, transparent, and high-quality experience for customers, staff, and administrators.

Core Values

• 🚀 Convenience: Book services anytime, anywhere.
• 🔎 Transparency: Clear pricing and service details.
• ⭐ Quality: Professional staff with rigorous quality control.
• 🌱 Sustainability: Eco-friendly products and practices.

---

🚀 Key Features

👤 Customers

• Account Management:
  • Register/login via email or phone.
  • Password recovery via email.
  • Update personal information and view booking history.
• Service Browsing:
  • Explore services with images, prices, and descriptions.
  • Search, filter, and sort by keywords, categories, price, ratings, or popularity.
• Booking:
  • Select services, specify address, notes, and preferred time.
• Service Reviews:
  • Rate and comment on completed services.
  • View service rankings based on customer feedback.

🕵️ Guest Users

• Browse and search services.
• Register/login or request consultation.

💼 Sales Staff

• Manage bookings and customer consultations.
• Update personal information.
• View consulted bookings and generate revenue reports.
• Receive real-time notifications.

🛠️ Technical Staff

• Manage schedules and update task progress.
• Confirm task completion or report issues.

🛡️ Administrators

• Manage service categories, customer accounts, and staff roles.
• Create, edit, or delete discounts and promotions.
• Handle customer complaints and support requests.
• Monitor consultations and system performance.

---

👥 System Actors & Permissions

Actor	Key Functions
Guest User	Browse/search services, register/login, request consultation.
Registered Customer	Book services, manage account, rate services, view history.
Sales Staff	Manage bookings, consult customers, update account, generate reports.
Technical Staff	Manage schedules, update task progress, report issues.
Administrator	Manage services, customers, staff, promotions, complaints, and permissions.

---

⚡ Quick Start

# Backend
cd backend
./mvnw spring-boot:run -Dspring-boot.run.profiles=local

# Frontend
cd frontend
npm install && npm start

See the Installation Guide for detailed setup instructions.

---

🏗️ System Architecture

DomiCare adopts a microservices architecture for scalability and maintainability, comprising:

Backend (Spring Boot)

• API Layer: RESTful endpoints for request/response handling.
• Service Layer: Core business logic.
• Repository Layer: Database interactions.
• Security Layer: Authentication and authorization.
• Email Service: Automated email notifications.
• File Storage Service: Image and file management.

Frontend (ReactJS)

• Public Portal: Customer-facing interface.
• Admin Portal: System management interface.
• Sales Portal: Sales staff dashboard.
• Technical Portal: Technical staff interface.

Infrastructure

• Database: PostgreSQL (cloud-hosted).
• File Storage: Cloudinary.
• Authentication: JWT + OAuth2.
• Caching: Redis (optional).
• CI/CD: GitHub Actions or Jenkins.

---

💻 Technology Stack

Backend

• Spring Boot: Core framework for Java development.
• Spring Security: Authentication and authorization.
• Spring Data JPA: Database interaction with ORM.
• JWT & OAuth2: Stateless authentication and third-party login (Google, Facebook).
• PostgreSQL: Relational database.
• Hibernate: ORM framework.
• Swagger/OpenAPI: API documentation.
• Maven: Dependency and build management.
• JUnit & Mockito: Unit testing.
• JavaMail: Email notifications.
• Cloudinary: Cloud-based image storage.
• Lombok: Boilerplate code reduction.

Frontend

• ReactJS: UI development framework.
• Redux: State management.
• Axios: HTTP client for API calls.
• React Router: Client-side routing.
• Material-UI: UI component library.
• Formik: Form management.
• React Query: Data fetching and caching.
• i18next: Multilingual support.
• Jest & React Testing Library: Testing.
• ESLint & Prettier: Code quality tools.

DevOps & Tools

• Docker: Containerization.
• Git: Version control.
• Postman: API testing.
• SonarQube: Code quality analysis.
• Prometheus & Grafana: Monitoring (optional).
• ELK Stack: Logging (optional).

---

🛠️ Installation Guide

Prerequisites

• JDK 11+
• Maven 3.6+
• Node.js 14+ and npm 6+
• PostgreSQL 12+
• Git

Backend Setup

1. Clone the Repository

   git clone https://github.com/your-username/domicare.git
   cd domicare/backend

2. Configure Database Create a PostgreSQL database:

   CREATE DATABASE domicare;

3. Set Up application-local.properties Create src/main/resources/application-local.properties:

   # Database
   spring.datasource.url=jdbc:postgresql://localhost:5432/domicare
   spring.datasource.username=your-db-username
   spring.datasource.password=your-db-password
   spring.datasource.driver-class-name=org.postgresql.Driver
   
   # JPA
   spring.jpa.hibernate.ddl-auto=update
   spring.jpa.show-sql=true
   spring.jpa.properties.hibernate.format_sql=true
   spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect
   
   # JWT
   jwt.secret=your-jwt-secret-key
   jwt.expiration=86400000
   
   # Email
   spring.mail.host=smtp.gmail.com
   spring.mail.port=587
   spring.mail.username=your-email@gmail.com
   spring.mail.password=your-email-app-password
   spring.mail.properties.mail.smtp.auth=true
   spring.mail.properties.mail.smtp.starttls.enable=true
   
   # OAuth2
   spring.security.oauth2.client.registration.google.client-id=your-google-client-id
   spring.security.oauth2.client.registration.google.client-secret=your-google-client-secret
   spring.security.oauth2.client.registration.google.scope=profile,email
   
   # Cloudinary
   cloudinary.cloud-name=your-cloud-name
   cloudinary.api-key=your-api-key
   cloudinary.api-secret=your-api-secret
   
   # Server
   server.port=8080

4. Build and Run

   mvn clean install
   mvn spring-boot:run -Dspring-boot.run.profiles=local

   Or use the JAR file:

   java -jar target/domicare-0.0.1-SNAPSHOT.jar --spring.profiles.active=local

Frontend Setup

1. Navigate to Frontend Directory

   cd ../frontend

2. Install Dependencies

   npm install

3. Configure API Endpoint Create .env.local:

   REACT_APP_API_BASE_URL=http://localhost:8080/api
   REACT_APP_CLOUDINARY_URL=https://api.cloudinary.com/v1_1/your-cloud-name/upload
   REACT_APP_GOOGLE_CLIENT_ID=your-google-client-id
   

4. Run Frontend

   npm start

5. Build for Production

   npm run build

---

🚢 Deployment Process

Environments

1. Local: Developer workstations.
2. Development: Internal testing.
3. Staging: User acceptance testing (UAT).
4. Production: Live environment.

CI/CD Pipeline

• Code Commit: Push to Git repository.
• Automated Tests: Run unit and integration tests.
• Code Quality: Analyze with SonarQube.
• Build: Compile with Maven/npm.
• Deploy: Deploy to target environment.
• Monitor: Track performance post-deployment.

---

📚 API Documentation

Access Swagger/OpenAPI documentation after starting the backend:

http://localhost:8080/swagger-ui.html

API Groups

• /api/auth: Authentication and authorization.
• /api/users: User management.
• /api/services: Service management.
• /api/orders: Booking management.
• /api/payments: Payment processing.
• /api/reviews: Service reviews.
• /api/media: Media upload and management.
• /api/posts: News and article management.

---

🔒 Security

Security Principles

• Authentication: JWT + OAuth2.
• Authorization: Role-based access control (RBAC).
• Data Protection: HTTPS/SSL encryption.
• Password Storage: BCrypt hashing.
• Input Validation: Sanitize and validate inputs.
• CORS: Restrict cross-origin requests.
• Rate Limiting: Prevent DOS attacks.

Secret Management

• Store secrets in environment variables or a vault.
• Exclude sensitive files from Git:

  # .gitignore
  application-local.properties
  application-dev.properties
  application-prod.properties
  .env.local
  .env.development
  .env.production
  

---

🎨 User Interface Highlights

Registration

• Form: Email, password, confirm password, and terms/privacy policy checkbox.
• Actions: Resend verification email or navigate to login page.
• Post-Registration: Email verification link sent for account activation.

Service Catalog

• Browse services by category with search, filter, and sort options (name, price, ratings).
• Detailed service pages with descriptions, authentic images, pricing, and discounts.

Booking History

• View past services with details and statuses.

Sales Staff Dashboard

• View and manage bookings to ensure timely customer consultations.
• Real-time notifications and revenue reports.

Admin Dashboard

• Analytics: Revenue, bookings, new customers, and service ratings visualized in charts.
• Staff Management: Add, edit, or delete staff with detailed information views.
• Service Management: Create, update, or delete services with intuitive forms for name, description, price, discount, category, and images.

---

📸 Screenshots

Registration	Service Catalog	Service Details

Booking History	Sales Dashboard	Admin Analytics

Email Verification	Staff Management	Service Management

---