Merge pull request #25 from firasrg/docs/24-rename-project

[Documentation][Management] Project new name

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # Contributing Guidelines
 
-Thank you for considering contributing to the **Car Service REST API** ! By participating, you're helping to build a more reliable and feature-rich community project. Please take a moment to review these guidelines to ensure a smooth collaboration.
+Thank you for considering contributing to the **AutoCare REST API** ! By participating, you're helping to build a more reliable and feature-rich community project. Please take a moment to review these guidelines to ensure a smooth collaboration.
 
 ## Table of Content
 

README.md

@@ -1,6 +1,6 @@
-# Car Service REST API sample
+# AutoCare REST API Sample
 
-[![Code Analysis](https://github.com/firasrg/car-service-rest-api/actions/workflows/code-analysis.yaml/badge.svg)](https://github.com/firasrg/car-service-rest-api/actions/workflows/code-analysis.yaml)
+[![Code Analysis](https://github.com/firasrg/auto-care/actions/workflows/code-analysis.yaml/badge.svg)](https://github.com/firasrg/auto-care/actions/workflows/code-analysis.yaml)
 [![java-version](https://img.shields.io/badge/Java-17-f0fc03)](https://img.shields.io/badge/Java-17-f0fc03)
 
 [![Bugs](https://sonarcloud.io/api/project_badges/measure?project=firasrg_car-service-rest-api&metric=bugs)](https://sonarcloud.io/summary/new_code?id=firasrg_car-service-rest-api)
@@ -10,7 +10,7 @@
 
 ## Overview
 
-The **Car Service REST API** 🚗🧑‍🔧  offers a comprehensive solution for managing car service systems. This developer-friendly project is designed to enhance proficiency with modern Spring applications, providing hands-on experience with real-world scenarios and best practices for backend development.
+The **AutoCare REST API** 🚗🧑‍🔧  offers a comprehensive solution for managing vehicle services . This developer-friendly project is designed to enhance proficiency with modern Spring applications, providing hands-on experience with real-world scenarios and best practices for backend development.
 
 **Goals** :
 
@@ -39,7 +39,7 @@ The **Car Service REST API** 🚗🧑‍🔧  offers a comprehensive solution fo
 
 ```bash
 git clone <GITHUB_REPOSITORY_URL>
-cd car-service-rest-api
+cd autocare-rest-api
 ```
 
 2. **Build**

pom.xml

@@ -9,11 +9,11 @@
 		<relativePath/> <!-- lookup parent from repository -->
 	</parent>
 	<groupId>com.frg</groupId>
-	<artifactId>car-service-rest-api</artifactId>
+	<artifactId>autocare-rest-api</artifactId>
 	<version>0.0.1-SNAPSHOT</version>
 	<packaging>jar</packaging>
-	<name>car-service-rest-api</name>
-	<description>Car service management system</description>
+	<name>AutoCare Sample App</name>
+	<description>AutoCare is a management system sample built as a Spring Boot REST API</description>
 	<url/>
 	<licenses>
 		<license/>
@@ -78,6 +78,9 @@
 							<artifactId>lombok</artifactId>
 						</exclude>
 					</excludes>
+					<image>
+						<name>firas1220/car-services</name>
+					</image>
 				</configuration>
 			</plugin>
 			<plugin>

src/main/java/com/frg/carservice/CarServiceApplication.java → src/main/java/com/frg/autocare/AutoCareApplication.java

@@ -1,6 +1,6 @@
 /**
- * Car Service REST API - Application's main class.
- * Copyright (C) 2024  Car Service REST API original author or authors.
+ * AutoCare REST API - Application's main class.
+ * Copyright (C) 2024  AutoCare REST API original author or authors.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as published
@@ -15,15 +15,15 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this application.  If not, see <https://www.gnu.org/licenses/>.
  */
-package com.frg.carservice;
+package com.frg.autocare;
 
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 
 @SpringBootApplication
-public class CarServiceApplication {
+public class AutoCareApplication {
 
   public static void main(String[] args) {
-    SpringApplication.run(CarServiceApplication.class, args);
+    SpringApplication.run(AutoCareApplication.class, args);
   }
 }

src/main/java/com/frg/carservice/configs/LoadDatabaseConfig.java → src/main/java/com/frg/autocare/configs/LoadDatabaseConfig.java

@@ -1,6 +1,6 @@
 /**
- * Car Service REST API - Load database configuration component.
- * Copyright (C) 2024  Car Service REST API original author or authors.
+ * AutoCare REST API - Load database configuration component.
+ * Copyright (C) 2024  AutoCare REST API original author or authors.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as published
@@ -15,18 +15,18 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this application.  If not, see <https://www.gnu.org/licenses/>.
  */
-package com.frg.carservice.configs;
+package com.frg.autocare.configs;
 
-import com.frg.carservice.entities.Car;
-import com.frg.carservice.entities.Client;
-import com.frg.carservice.entities.Maintainer;
-import com.frg.carservice.entities.Tool;
-import com.frg.carservice.entities.User;
-import com.frg.carservice.repository.CarRepository;
-import com.frg.carservice.repository.ClientRepository;
-import com.frg.carservice.repository.MaintainerRepository;
-import com.frg.carservice.repository.ToolRepository;
-import com.frg.carservice.repository.UserRepository;
+import com.frg.autocare.entities.Car;
+import com.frg.autocare.entities.Client;
+import com.frg.autocare.entities.Maintainer;
+import com.frg.autocare.entities.Tool;
+import com.frg.autocare.entities.User;
+import com.frg.autocare.repository.CarRepository;
+import com.frg.autocare.repository.ClientRepository;
+import com.frg.autocare.repository.MaintainerRepository;
+import com.frg.autocare.repository.ToolRepository;
+import com.frg.autocare.repository.UserRepository;
 import org.springframework.boot.CommandLineRunner;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;

src/main/java/com/frg/carservice/constants/IDEs.java → src/main/java/com/frg/autocare/constants/IDEs.java

@@ -1,6 +1,6 @@
 /**
- * Car Service REST API - IDE names constants class.
- * Copyright (C) 2024  Car Service REST API original author or authors.
+ * AutoCare REST API - IDE names constants class.
+ * Copyright (C) 2024  AutoCare REST API original author or authors.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as published
@@ -15,7 +15,7 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this application.  If not, see <https://www.gnu.org/licenses/>.
  */
-package com.frg.carservice.constants;
+package com.frg.autocare.constants;
 
 import lombok.experimental.UtilityClass;
 

src/main/java/com/frg/carservice/controllers/CarController.java → src/main/java/com/frg/autocare/controllers/CarController.java

@@ -1,6 +1,6 @@
 /**
- * Car Service REST API - Car controller class.
- * Copyright (C) 2024  Car Service REST API original author or authors.
+ * AutoCare REST API - Car controller class.
+ * Copyright (C) 2024  AutoCare REST API original author or authors.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as published
@@ -15,9 +15,9 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this application.  If not, see <https://www.gnu.org/licenses/>.
  */
-package com.frg.carservice.controllers;
+package com.frg.autocare.controllers;
 
-import com.frg.carservice.services.CarService;
+import com.frg.autocare.services.CarService;
 import lombok.RequiredArgsConstructor;
 import org.springframework.http.MediaType;
 import org.springframework.http.ResponseEntity;

src/main/java/com/frg/carservice/entities/Car.java → src/main/java/com/frg/autocare/entities/Car.java

@@ -1,6 +1,6 @@
 /**
- * Car Service REST API - Car entity class.
- * Copyright (C) 2024  Car Service REST API original author or authors.
+ * AutoCare REST API - Car entity class.
+ * Copyright (C) 2024  AutoCare REST API original author or authors.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as published
@@ -15,9 +15,9 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this application.  If not, see <https://www.gnu.org/licenses/>.
  */
-package com.frg.carservice.entities;
+package com.frg.autocare.entities;
 
-import com.frg.carservice.constants.IDEs;
+import com.frg.autocare.constants.IDEs;
 import jakarta.annotation.Generated;
 import jakarta.persistence.Entity;
 import jakarta.persistence.GeneratedValue;

src/main/java/com/frg/carservice/entities/Client.java → src/main/java/com/frg/autocare/entities/Client.java

@@ -1,6 +1,6 @@
 /**
- * Car Service REST API - Client entity class.
- * Copyright (C) 2024  Car Service REST API original author or authors.
+ * AutoCare REST API - Client entity class.
+ * Copyright (C) 2024  AutoCare REST API original author or authors.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as published
@@ -15,9 +15,9 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this application.  If not, see <https://www.gnu.org/licenses/>.
  */
-package com.frg.carservice.entities;
+package com.frg.autocare.entities;
 
-import com.frg.carservice.constants.IDEs;
+import com.frg.autocare.constants.IDEs;
 import jakarta.annotation.Generated;
 import jakarta.persistence.Entity;
 import jakarta.persistence.GeneratedValue;

src/main/java/com/frg/carservice/entities/Maintainer.java → src/main/java/com/frg/autocare/entities/Maintainer.java

@@ -1,6 +1,6 @@
 /**
- * Car Service REST API - Maintainer entity class.
- * Copyright (C) 2024  Car Service REST API original author or authors.
+ * AutoCare REST API - Maintainer entity class.
+ * Copyright (C) 2024  AutoCare REST API original author or authors.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as published
@@ -15,9 +15,9 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this application.  If not, see <https://www.gnu.org/licenses/>.
  */
-package com.frg.carservice.entities;
+package com.frg.autocare.entities;
 
-import com.frg.carservice.constants.IDEs;
+import com.frg.autocare.constants.IDEs;
 import jakarta.annotation.Generated;
 import jakarta.persistence.Entity;
 import jakarta.persistence.GeneratedValue;

src/main/java/com/frg/carservice/entities/Tool.java → src/main/java/com/frg/autocare/entities/Tool.java

@@ -1,6 +1,6 @@
 /**
- * Car Service REST API - Tool entity class.
- * Copyright (C) 2024  Car Service REST API original author or authors.
+ * AutoCare REST API - Tool entity class.
+ * Copyright (C) 2024  AutoCare REST API original author or authors.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as published
@@ -15,9 +15,9 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this application.  If not, see <https://www.gnu.org/licenses/>.
  */
-package com.frg.carservice.entities;
+package com.frg.autocare.entities;
 
-import com.frg.carservice.constants.IDEs;
+import com.frg.autocare.constants.IDEs;
 import jakarta.annotation.Generated;
 import jakarta.persistence.Entity;
 import jakarta.persistence.GeneratedValue;

src/main/java/com/frg/carservice/entities/User.java → src/main/java/com/frg/autocare/entities/User.java

@@ -1,6 +1,6 @@
 /**
- * Car Service REST API - User entity class.
- * Copyright (C) 2024  Car Service REST API original author or authors.
+ * AutoCare REST API - User entity class.
+ * Copyright (C) 2024  AutoCare REST API original author or authors.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as published
@@ -15,9 +15,9 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this application.  If not, see <https://www.gnu.org/licenses/>.
  */
-package com.frg.carservice.entities;
+package com.frg.autocare.entities;
 
-import com.frg.carservice.constants.IDEs;
+import com.frg.autocare.constants.IDEs;
 import jakarta.annotation.Generated;
 import jakarta.persistence.Entity;
 import jakarta.persistence.GeneratedValue;

src/main/java/com/frg/carservice/repository/CarRepository.java → src/main/java/com/frg/autocare/repository/CarRepository.java

@@ -1,6 +1,6 @@
 /**
- * Car Service REST API - Car repository component.
- * Copyright (C) 2024  Car Service REST API original author or authors.
+ * AutoCare REST API - Car repository component.
+ * Copyright (C) 2024  AutoCare REST API original author or authors.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as published
@@ -15,9 +15,9 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this application.  If not, see <https://www.gnu.org/licenses/>.
  */
-package com.frg.carservice.repository;
+package com.frg.autocare.repository;
 
-import com.frg.carservice.entities.Car;
+import com.frg.autocare.entities.Car;
 import org.springframework.data.jpa.repository.JpaRepository;
 import org.springframework.stereotype.Repository;
 

src/main/java/com/frg/carservice/repository/ClientRepository.java → src/main/java/com/frg/autocare/repository/ClientRepository.java

@@ -1,6 +1,6 @@
 /**
- * Car Service REST API - Client repository component.
- * Copyright (C) 2024  Car Service REST API original author or authors.
+ * AutoCare REST API - Client repository component.
+ * Copyright (C) 2024  AutoCare REST API original author or authors.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as published
@@ -15,9 +15,9 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this application.  If not, see <https://www.gnu.org/licenses/>.
  */
-package com.frg.carservice.repository;
+package com.frg.autocare.repository;
 
-import com.frg.carservice.entities.Client;
+import com.frg.autocare.entities.Client;
 import org.springframework.data.repository.CrudRepository;
 import org.springframework.stereotype.Repository;
 

src/main/java/com/frg/carservice/repository/MaintainerRepository.java → src/main/java/com/frg/autocare/repository/MaintainerRepository.java

@@ -1,6 +1,6 @@
 /**
- * Car Service REST API - Maintainer repository component.
- * Copyright (C) 2024  Car Service REST API original author or authors.
+ * AutoCare REST API - Maintainer repository component.
+ * Copyright (C) 2024  AutoCare REST API original author or authors.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as published
@@ -15,9 +15,9 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this application.  If not, see <https://www.gnu.org/licenses/>.
  */
-package com.frg.carservice.repository;
+package com.frg.autocare.repository;
 
-import com.frg.carservice.entities.Maintainer;
+import com.frg.autocare.entities.Maintainer;
 import org.springframework.data.repository.CrudRepository;
 import org.springframework.stereotype.Repository;
 

src/main/java/com/frg/carservice/repository/ToolRepository.java → src/main/java/com/frg/autocare/repository/ToolRepository.java

@@ -1,6 +1,6 @@
 /**
- * Car Service REST API - Tool repository component.
- * Copyright (C) 2024  Car Service REST API original author or authors.
+ * AutoCare REST API - Tool repository component.
+ * Copyright (C) 2024  AutoCare REST API original author or authors.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as published
@@ -15,9 +15,9 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this application.  If not, see <https://www.gnu.org/licenses/>.
  */
-package com.frg.carservice.repository;
+package com.frg.autocare.repository;
 
-import com.frg.carservice.entities.Tool;
+import com.frg.autocare.entities.Tool;
 import java.util.List;
 import org.springframework.data.jpa.repository.Query;
 import org.springframework.data.repository.CrudRepository;

src/main/java/com/frg/carservice/repository/UserRepository.java → src/main/java/com/frg/autocare/repository/UserRepository.java

@@ -1,6 +1,6 @@
 /**
- * Car Service REST API - User repository component.
- * Copyright (C) 2024  Car Service REST API original author or authors.
+ * AutoCare REST API - User repository component.
+ * Copyright (C) 2024  AutoCare REST API original author or authors.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as published
@@ -15,9 +15,9 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this application.  If not, see <https://www.gnu.org/licenses/>.
  */
-package com.frg.carservice.repository;
+package com.frg.autocare.repository;
 
-import com.frg.carservice.entities.User;
+import com.frg.autocare.entities.User;
 import org.springframework.data.repository.CrudRepository;
 import org.springframework.stereotype.Repository;