From b407c1f7228db555cee5d8144e639b1f510ee936 Mon Sep 17 00:00:00 2001
From: Zaine Arch <zaineulabideen@outlook.com>
Date: Thu, 1 Jan 2026 17:01:30 +0000
Subject: [PATCH] Setup basic project, runs on 8080 localhost

---
 .gitignore                                    |  4 +
 Makefile                                      | 29 ++++++
 README.md                                     |  9 ++
 pom.xml                                       | 97 ++++++-------------
 src/main/java/org/zaine/app/App.java          | 10 --
 src/main/java/org/zaine/app/Application.java  | 13 +++
 .../app/controller/HealthController.java      | 13 +++
 src/test/java/org/zaine/app/AppTest.java      | 19 ----
 .../java/org/zaine/app/ApplicationTest.java   | 11 +++
 9 files changed, 108 insertions(+), 97 deletions(-)
 create mode 100644 Makefile
 create mode 100644 README.md
 delete mode 100644 src/main/java/org/zaine/app/App.java
 create mode 100644 src/main/java/org/zaine/app/Application.java
 create mode 100644 src/main/java/org/zaine/app/controller/HealthController.java
 delete mode 100644 src/test/java/org/zaine/app/AppTest.java
 create mode 100644 src/test/java/org/zaine/app/ApplicationTest.java

diff --git a/.gitignore b/.gitignore
index bcc52fe..c82eeba 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,2 +1,6 @@
 *~
 target/
+application.properties
+.settings/
+.project
+.classpath
\ No newline at end of file
diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..916a009
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,29 @@
+.PHONY: compile run clean verify test help
+
+compile:
+	@echo "Compiling source files..."
+	mvn compile
+
+run:
+	@echo "Running the application..."
+	mvn clean spring-boot:run
+
+clean:
+	@echo "Cleaning build artifacts..."
+	mvn clean
+
+verify:
+	@echo "Running tests and verifications..."
+	mvn verify
+
+test:
+	@echo "Running tests..."
+	mvn test
+
+help:
+	@echo "Available targets:"
+	@echo "  make compile  - Compile the source files"
+	@echo "  make clean    - Clean build artifacts"
+	@echo "  make verify   - Run tests and verifications"
+	@echo "  make test     - Run tests"
+	@echo "  make help     - Show this help message"
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c6d3d94
--- /dev/null
+++ b/README.md
@@ -0,0 +1,9 @@
+
+# Introduction
+
+This repository contains the source code and documentation for all of my APIs. It serves as a centralised location for my self-hosted services to use.
+
+
+# Structure
+
+The repository is organised into the following main directories:
diff --git a/pom.xml b/pom.xml
index 72f0f78..ea4f0b0 100644
--- a/pom.xml
+++ b/pom.xml
@@ -1,90 +1,51 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
+                             https://maven.apache.org/xsd/maven-4.0.0.xsd">
+
   <modelVersion>4.0.0</modelVersion>
 
   <groupId>org.zaine.app</groupId>
   <artifactId>org-backend</artifactId>
-  <version>1.0-SNAPSHOT</version>
-
+  <version>1.0.0-SNAPSHOT</version>
   <name>org-backend</name>
-  <!-- FIXME change it to the project's website -->
   <url>https://zainezq.com/api</url>
 
+  <parent>
+    <groupId>org.springframework.boot</groupId>
+    <artifactId>spring-boot-starter-parent</artifactId>
+    <version>3.2.1</version>
+    <relativePath/>
+  </parent>
+
   <properties>
-    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-    <maven.compiler.release>17</maven.compiler.release>
+    <java.version>17</java.version>
+    <start-class>org.zaine.app.Application</start-class>
   </properties>
 
-  <dependencyManagement>
-    <dependencies>
-      <dependency>
-        <groupId>org.junit</groupId>
-        <artifactId>junit-bom</artifactId>
-        <version>5.11.0</version>
-        <type>pom</type>
-        <scope>import</scope>
-      </dependency>
-    </dependencies>
-  </dependencyManagement>
-
   <dependencies>
+
     <dependency>
-      <groupId>org.junit.jupiter</groupId>
-      <artifactId>junit-jupiter-api</artifactId>
-      <scope>test</scope>
+      <groupId>org.springframework.boot</groupId>
+      <artifactId>spring-boot-starter-web</artifactId>
     </dependency>
-    <!-- Optionally: parameterized tests support -->
+
     <dependency>
-      <groupId>org.junit.jupiter</groupId>
-      <artifactId>junit-jupiter-params</artifactId>
+      <groupId>org.springframework.boot</groupId>
+      <artifactId>spring-boot-starter-test</artifactId>
       <scope>test</scope>
     </dependency>
   </dependencies>
 
   <build>
-    <pluginManagement><!-- lock down plugins versions to avoid using Maven defaults (may be moved to parent pom) -->
-      <plugins>
-        <!-- clean lifecycle, see https://maven.apache.org/ref/current/maven-core/lifecycles.html#clean_Lifecycle -->
-        <plugin>
-          <artifactId>maven-clean-plugin</artifactId>
-          <version>3.4.0</version>
-        </plugin>
-        <!-- default lifecycle, jar packaging: see https://maven.apache.org/ref/current/maven-core/default-bindings.html#Plugin_bindings_for_jar_packaging -->
-        <plugin>
-          <artifactId>maven-resources-plugin</artifactId>
-          <version>3.3.1</version>
-        </plugin>
-        <plugin>
-          <artifactId>maven-compiler-plugin</artifactId>
-          <version>3.13.0</version>
-        </plugin>
-        <plugin>
-          <artifactId>maven-surefire-plugin</artifactId>
-          <version>3.3.0</version>
-        </plugin>
-        <plugin>
-          <artifactId>maven-jar-plugin</artifactId>
-          <version>3.4.2</version>
-        </plugin>
-        <plugin>
-          <artifactId>maven-install-plugin</artifactId>
-          <version>3.1.2</version>
-        </plugin>
-        <plugin>
-          <artifactId>maven-deploy-plugin</artifactId>
-          <version>3.1.2</version>
-        </plugin>
-        <!-- site lifecycle, see https://maven.apache.org/ref/current/maven-core/lifecycles.html#site_Lifecycle -->
-        <plugin>
-          <artifactId>maven-site-plugin</artifactId>
-          <version>3.12.1</version>
-        </plugin>
-        <plugin>
-          <artifactId>maven-project-info-reports-plugin</artifactId>
-          <version>3.6.1</version>
-        </plugin>
-      </plugins>
-    </pluginManagement>
+    <plugins>
+      <plugin>
+        <groupId>org.springframework.boot</groupId>
+        <artifactId>spring-boot-maven-plugin</artifactId>
+      </plugin>
+
+    </plugins>
   </build>
+
 </project>
diff --git a/src/main/java/org/zaine/app/App.java b/src/main/java/org/zaine/app/App.java
deleted file mode 100644
index 95ec5ae..0000000
--- a/src/main/java/org/zaine/app/App.java
+++ /dev/null
@@ -1,10 +0,0 @@
-package org.zaine.app;
-
-/**
- * Hello world!
- */
-public class App {
-    public static void main(String[] args) {
-        System.out.println("Hello World!");
-    }
-}
diff --git a/src/main/java/org/zaine/app/Application.java b/src/main/java/org/zaine/app/Application.java
new file mode 100644
index 0000000..c0b1300
--- /dev/null
+++ b/src/main/java/org/zaine/app/Application.java
@@ -0,0 +1,13 @@
+package org.zaine.app;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+
+@SpringBootApplication
+public class Application {
+    public static void main(String[] args) {
+        SpringApplication.run(Application.class, args);
+    }
+
+}
diff --git a/src/main/java/org/zaine/app/controller/HealthController.java b/src/main/java/org/zaine/app/controller/HealthController.java
new file mode 100644
index 0000000..02f9bb4
--- /dev/null
+++ b/src/main/java/org/zaine/app/controller/HealthController.java
@@ -0,0 +1,13 @@
+package org.zaine.app;
+
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+public class HealthController {
+
+    @GetMapping("/health")
+    public String health() {
+        return "OK";
+    }
+}
diff --git a/src/test/java/org/zaine/app/AppTest.java b/src/test/java/org/zaine/app/AppTest.java
deleted file mode 100644
index e4876cc..0000000
--- a/src/test/java/org/zaine/app/AppTest.java
+++ /dev/null
@@ -1,19 +0,0 @@
-package org.zaine.app;
-
-import static org.junit.jupiter.api.Assertions.assertTrue;
-
-import org.junit.jupiter.api.Test;
-
-/**
- * Unit test for simple App.
- */
-public class AppTest {
-
-    /**
-     * Rigorous Test :-)
-     */
-    @Test
-    public void shouldAnswerWithTrue() {
-        assertTrue(true);
-    }
-}
diff --git a/src/test/java/org/zaine/app/ApplicationTest.java b/src/test/java/org/zaine/app/ApplicationTest.java
new file mode 100644
index 0000000..b45797e
--- /dev/null
+++ b/src/test/java/org/zaine/app/ApplicationTest.java
@@ -0,0 +1,11 @@
+package org.zaine.app;
+
+import static org.junit.jupiter.api.Assertions.assertTrue;
+import static org.junit.jupiter.api.Assertions.*;
+import org.junit.jupiter.api.Test;
+
+public class ApplicationTest {
+
+
+
+}