docs: add local development setup guide and .env.example

.env.example

@@ -0,0 +1,34 @@
+# ===========================
+# Application Configuration
+# ===========================
+
+APP_HOST_NAME=localhost
+
+# ===========================
+# GitHub API
+# ===========================
+
+GithubBearer=<your_github_personal_access_token>
+
+# ===========================
+# IPInfo
+# ===========================
+
+IP_INFO_TOKEN=<your_ipinfo_token>
+IP_INFO_CACHE_SIZE=1000
+
+# ===========================
+# Email
+# ===========================
+
+EMAIL_USERNAME=<smtp_username>
+EMAIL_PASSWORD=<smtp_password>
+
+# ===========================
+# Feature Flags
+# ===========================
+
+AUTO_UPLOAD_ENABLED=true
+AUTO_UPLOAD_META_ENABLED=true
+FEED_GENERATION_ENABLED=true
+REQUEST_LOGGING_ENABLED=true

README.md

@@ -14,6 +14,7 @@ YAGFI - yet another good first issue
 * [Introduction](#introduction)
   * [Why yet another good-first-issue project?](#why-yet-another-good-first-issue-project)
   * [Implementation](#implementation)
+  * [Local Deployment](#local-development)
   * [Frontend](#frontend)
 * [What's next](#whats-next)
 <!-- TOC -->  
@@ -45,6 +46,35 @@ To compare with, look for other similar projects:
 - The list of current supported issues is [here](https://github.com/Regyl/yagfi-back/blob/master/src/main/resources/data/labels.txt)
   - See [CONTRIBUTING](https://github.com/Regyl/yagfi-back/tree/master/docs/CONTRUBUTING.md) if you found some unsupported labels
 
+
+  ## Local Development
+
+### Prerequisites
+
+- Java 25
+- Maven
+- PostgreSQL
+- Git
+
+### Environment Variables
+
+Create a `.env` file based on `.env.example`.
+
+The following variables are required:
+
+| Variable | Description |
+|----------|-------------|
+| APP_HOST_NAME | PostgreSQL host |
+| GithubBearer | GitHub Personal Access Token |
+| IP_INFO_TOKEN | API token from ipinfo.io |
+| EMAIL_USERNAME | SMTP username |
+| EMAIL_PASSWORD | SMTP password |
+
+### PostgreSQL
+
+The application connects to PostgreSQL using
+
+
 ## Frontend
 Frontend for this project is placed [here](https://github.com/Regyl/yagfi-front). Yes, it's vibe-coded. 
 Just because firstly I am a backend developer. See [CONTRIBUTING](https://github.com/Regyl/yagfi-back/tree/master/docs/CONTRUBUTING.md)

docs/LOCAL_SETUP.md

@@ -0,0 +1,37 @@
+# Local Development Guide
+
+## 1. Clone
+
+git clone https://github.com/Regyl/yagfi-back.git
+
+## 2. Install
+
+- Java 25
+- Maven
+- PostgreSQL
+
+## 3. Configure Environment Variables
+
+Copy
+
+.env.example
+
+to
+
+.env
+
+and fill all required values.
+
+## 4. Database
+
+Create database
+
+uj
+
+Create schema
+
+gfi
+
+## 5. Start
+
+mvn spring-boot:run

pom.xml

@@ -36,7 +36,7 @@
         <!--plugins-->
         <jib.version>3.5.1</jib.version>
         <checkstyle.version>3.3.1</checkstyle.version>
-        <java.version>25</java.version>
+        <java.version>21</java.version>
         <maven.compiler.source>${java.version}</maven.compiler.source>
         <maven.compiler.target>${java.version}</maven.compiler.target>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
@@ -243,18 +243,20 @@
                     </annotationProcessorPaths>
                 </configuration>
             </plugin>
-            <plugin>
-                <groupId>org.springframework.boot</groupId>
-                <artifactId>spring-boot-maven-plugin</artifactId>
-                <configuration>
-                    <excludes>
-                        <exclude>
-                            <groupId>org.projectlombok</groupId>
-                            <artifactId>lombok</artifactId>
-                        </exclude>
-                    </excludes>
-                </configuration>
-            </plugin>
+          <plugin>
+    <groupId>org.springframework.boot</groupId>
+    <artifactId>spring-boot-maven-plugin</artifactId>
+    <configuration>
+        <mainClass>com.github.regyl.gfi.YagfiApplication</mainClass>
+
+        <excludes>
+            <exclude>
+                <groupId>org.projectlombok</groupId>
+                <artifactId>lombok</artifactId>
+            </exclude>
+        </excludes>
+    </configuration>
+</plugin>
 
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>

src/main/java/com/github/regyl/gfi/YagfiApplication.java

@@ -8,8 +8,8 @@
 @ConfigurationPropertiesScan(basePackages = "com.github.regyl.gfi.configuration")
 public class YagfiApplication {
 
-    static void main(String[] args) {
+    public static void main(String[] args) {
         SpringApplication.run(YagfiApplication.class, args);
     }
 
-}
+}