From 7d468673203c6d3d4de955efb21325a9bc034a2c Mon Sep 17 00:00:00 2001
From: bryce <git@brycefromnz.live>
Date: Sun, 27 Oct 2024 16:27:55 +1300
Subject: [PATCH] Files & Folders + started on pom.xml

---
 .../com/example/bricklog/BrickLogClient.java  |  0
 .../com/example/bricklog/BrickLogClient.java  |  0
 BrickLog-Server/pom.xml                       | 76 +++++++++++++++++++
 .../example/bricklog/BrickLogApplication.java | 15 ++++
 .../java/resources/application.properties     |  0
 README.md                                     | 30 +++++++-
 6 files changed, 120 insertions(+), 1 deletion(-)
 create mode 100644 BrickLog-Client/src/main/java/com/example/bricklog/BrickLogClient.java
 create mode 100644 BrickLog-Client/src/test/java/com/example/bricklog/BrickLogClient.java
 create mode 100644 BrickLog-Server/pom.xml
 create mode 100644 BrickLog-Server/src/main/java/com/example/bricklog/BrickLogApplication.java
 create mode 100644 BrickLog-Server/src/main/java/resources/application.properties

diff --git a/BrickLog-Client/src/main/java/com/example/bricklog/BrickLogClient.java b/BrickLog-Client/src/main/java/com/example/bricklog/BrickLogClient.java
new file mode 100644
index 0000000..e69de29
diff --git a/BrickLog-Client/src/test/java/com/example/bricklog/BrickLogClient.java b/BrickLog-Client/src/test/java/com/example/bricklog/BrickLogClient.java
new file mode 100644
index 0000000..e69de29
diff --git a/BrickLog-Server/pom.xml b/BrickLog-Server/pom.xml
new file mode 100644
index 0000000..96841d2
--- /dev/null
+++ b/BrickLog-Server/pom.xml
@@ -0,0 +1,76 @@
+<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">
+    <modelVersion>4.0.0</modelVersion>
+
+    <groupId>com.example</groupId>
+    <artifactId>BrickLog-Server</artifactId>
+    <version>0.1-SNAPSHOT</version>
+    <packaging>jar</packaging>
+
+    <properties>
+        <java.version>21</java.version>
+        <spring.boot.version>3.1.1</spring.boot.version> <!-- Use the latest version -->
+        <javafx.version>21.0.5</javafx.version> <!-- Use the appropriate JavaFX version -->
+    </properties>
+
+    <dependencies>
+        <!-- Spring Boot Starter Web -->
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-web</artifactId>
+        </dependency>
+
+        <!-- Spring Data JPA -->
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-data-jpa</artifactId>
+        </dependency>
+
+        <!-- Database Driver (e.g., H2, MySQL, PostgreSQL) -->
+        <dependency>
+            <groupId>com.h2database</groupId> <!-- Change this to your database -->
+            <artifactId>h2</artifactId>
+            <scope>runtime</scope>
+        </dependency>
+
+        <!-- Spring Boot Starter Test -->
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-test</artifactId>
+            <version>${spring.boot.version}</version>
+            <scope>test</scope>
+        </dependency>
+
+        <!-- JavaFX Dependencies -->
+        <dependency>
+            <groupId>org.openjfx</groupId>
+            <artifactId>javafx-controls</artifactId>
+            <version>${javafx.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.openjfx</groupId>
+            <artifactId>javafx-fxml</artifactId>
+            <version>${javafx.version}</version>
+        </dependency>
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.springframework.boot</groupId>
+                <artifactId>spring-boot-maven-plugin</artifactId>
+                <version>${spring.boot.version}</version>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <version>3.8.1</version>
+                <configuration>
+                    <source>${java.version}</source>
+                    <target>${java.version}</target>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+</project>
diff --git a/BrickLog-Server/src/main/java/com/example/bricklog/BrickLogApplication.java b/BrickLog-Server/src/main/java/com/example/bricklog/BrickLogApplication.java
new file mode 100644
index 0000000..2c8a9ee
--- /dev/null
+++ b/BrickLog-Server/src/main/java/com/example/bricklog/BrickLogApplication.java
@@ -0,0 +1,15 @@
+package com.example.bricklog;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.data.jpa.repository.config.EnableJpaRepositories;
+
+@SpringBootApplication
+@EnableJpaRepositories(basePackages = "com.example.bricklog.repository") // Adjust if needed
+public class BrickLogApplication {
+
+    public static void main(String[] args) {
+        SpringApplication.run(BrickLogApplication.class, args);
+        System.out.println("BrickLog Server is running...");
+    }
+}
diff --git a/BrickLog-Server/src/main/java/resources/application.properties b/BrickLog-Server/src/main/java/resources/application.properties
new file mode 100644
index 0000000..e69de29
diff --git a/README.md b/README.md
index da9c836..e783b32 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,31 @@
 # BrickLog
 
-A Client application that interfaces with BrickLog-Server to store and manage Lego builds and MoC creations
\ No newline at end of file
+A Client application that interfaces with BrickLog-Server to store and manage Lego builds and MoC creations.
+
+The Client should be able to be used on linux and windows systems ass it will be Java based.
+
+The Server will be made Docker compatible and there may be other versions made as well (ie. no Docker needed)
+
+### Features:
+- A GUI (so youdon't have to use the command line or terminal)
+- Ability to quickly see your builds
+    - See who built them
+    - see whether it is a Kit or a MoC
+    - see details of the build (Piece count, Price, Link to the kit on Lego.com etc) [ this should be direct from the lego.com website ]
+    - browse a gallery of the build images
+    - builds and builders will be searchable (search: [ builderName123 ] will only show all builds that builderName123 has done)
+- A quick Server that stores all the information
+
+## [!WARNING]
+- There will not be a username / password to access the information from the Client.
+- There will be the neccassary auth on the server side to make sure that the databse is secure and only the Client can access the server's database.
+
+### Minimal Config Needed
+The following will be needed to make the connection to the server from the client:
+
+- The server's IP address (link) will need to be added to the relevant setting dialogue when the client starts
+
+## [!NOTE]
+You should be able to access the data and create / edit / delete records with just the above setup.
+
+        - N.B. There will eventually be a "dark" mode but this will be a while down the track and located in the Client -> Settings -> Client Theme option
\ No newline at end of file