HOMESERVICE

Transforming Home Care, Seamlessly and Securely

Built with the tools and technologies:

---

Table of Contents

• Overview
• Getting Started
  • Prerequisites
  • Installation
  • Usage
  • Testing

---

Overview

HomeService is a comprehensive backend framework tailored for building scalable, secure home service platforms. It leverages Spring Boot to deliver core functionalities such as web services, security, data persistence, JWT authentication, and API documentation, all within a modular architecture.

Why HomeService?

This project simplifies the development of reliable, microservice-based home service applications. The core features include:

• Security & Authentication: Implements JWT-based security with role-based access control to safeguard your APIs.
• RESTful API Endpoints: Provides structured endpoints for managing users, services, appointments, reviews, and provider availability.
• Containerized Deployment: Uses Docker for consistent, portable deployment across environments.
• Auto-Generated API Docs: Integrates Swagger/OpenAPI for seamless API documentation and testing.
• Robust Error Handling: Centralized exception management ensures clear, consistent responses.
• Modular Data Flow: Utilizes DTOs and mappers for clean, maintainable data exchange.

---

Getting Started

Prerequisites

This project requires the following dependencies:

• Programming Language: Java
• Package Manager: Maven
• Container Runtime: Docker

Installation

Build HomeService from the source and install dependencies:

1. Clone the repository:

   git clone [https://github.com/Imad-Iyad/HomeService](https://github.com/Imad-Iyad/HomeService)

2. Navigate to the project directory:

   cd HomeService

3. Install the dependencies:

   Using docker:

   docker build -t Imad-Iyad/HomeService .

   Using maven:

   mvn install

Usage

Run the project with:

Using docker:

docker run -it {image_name}

Using maven:

mvn exec:java