Merge branch 'main' of https://github.com/Verpxnter/SpringCloud

id

Author: JadnK

README.md

@@ -1,6 +1,6 @@
-# SpringCloud Dashboard
+# 🌤️ SpringCloud Dashboard v3
 
-A simple and modern web-based dashboard application built using **Spring Boot** and **Thymeleaf**. This project allows users to manage their cloud files, upload, preview, download, and delete files in a secure and user-friendly environment.
+**SpringCloud Dashboard v3** is a modern, cloud-based dashboard built with **Spring Boot** and **Thymeleaf**, designed to help users manage cloud files in a secure, responsive, and user-friendly environment. You can upload, preview, download, and delete files, with admin-level file management and improved performance.
 
 ---
 
@@ -11,108 +11,112 @@ A simple and modern web-based dashboard application built using **Spring Boot**
 3. [Installation](#installation)
 4. [Usage](#usage)
 5. [Contributing](#contributing)
+6. [Reporting Issues](#reporting-issues)
 
 ---
 
 ## Features
 
-- **User Authentication**: Login and Logout functionality, with user-specific roles.
-- **File Management**: Upload, preview, download, and delete files.
-- **Responsive Design**: A fully responsive user interface that adapts to different screen sizes.
-- **Previewing Files**: Support for previewing images, videos, text files, and PDFs.
-- **Admin Panel**: Admin users can view and manage files uploaded by others.
+- **User Authentication**: Secure login/logout with role-based access.
+- **File Management**: Upload, preview, download, and delete files from the cloud.
+- **Responsive UI**: Fully responsive layout for desktop, tablet, and mobile.
+- **File Preview**: Preview images, videos, text files, and PDFs from the cloud.
+- **Admin Panel**: Admins can view and manage all uploaded files.
+- **Improved Performance**: Optimized backend and frontend for faster load times.
+- **Enhanced Overlay**: Redesigned, intuitive overlay for easier navigation.
+- **Install/Uninstall Scripts**: Simplified scripts for setup and removal.
+- **No Port Required**: Access the dashboard via `http://YOUR_IP/springcloud/`.
 
 ---
 
 ## Technologies Used
 
-- **Spring Boot**: Backend framework for building the RESTful API and serving the frontend.
-- **Thymeleaf**: Template engine for rendering dynamic HTML pages.
-- **HTML5 & CSS3**: For building the structure and styling the UI.
-- **JavaScript**: For handling client-side interactions (like file preview and upload popup).
-- **Spring Security**: For user authentication and role-based access control.
-- **Java 17**: The project uses Java 17 as the runtime environment.
-- **Gradle**: Build automation tool for managing project dependencies and building the project.
+- **Spring Boot** – Backend framework for REST APIs and serving frontend
+- **Thymeleaf** – Template engine for dynamic HTML rendering
+- **TailwindCSS** – Lightweight, responsive UI styling
+- **HTML5 & CSS3** – Structure and styling of pages
+- **JavaScript** – Client-side interactions and previews
+- **Spring Security** – Authentication and role-based access
+- **Java 17** – Runtime environment
+- **Gradle** – Build automation and dependency management
 
 ---
 
 ## Installation
 
-To run this project locally, follow these steps:
-
 ### Prerequisites
 
 - **Java 17** (JDK 17 or newer)
 - **Gradle** (for building the project)
-- **IDE** (like IntelliJ IDEA, Eclipse, etc.)
-- **MariaDB-Datenbank** (Local Storage is Comming Soon)
+- **MariaDB Database** (or another supported SQL database)
+- **Shell/Terminal access** to run scripts
 
 ### Steps
 
-1. **Download the latest release from GitHub**:
-   - Go to the [GitHub Releases page](https://github.com/verpxnter/springcloud/releases) and download the latest **.jar** and **install.sh** file.
-   
-   **Important**: You should only download the project from the **Releases** section on GitHub, not from the source code directly, as the releases are pre-compiled and ready to run.
-
-2. **Run the application**:
-
-   Once you have the **.sh** file from the releases, you can start the application with the following command:
+1. **Download the latest release**:  
+   Go to the [GitHub Releases page](https://github.com/verpxnter/springcloud/releases) and download the latest `.jar` and `install.sh`.
 
-   ```bash
+2. **Run the install script**:  
    ./install.sh
-   ```
-
-   This assumes you have an external MariaDB database. Update the database connection details as per your setup.
-
-5. The application will run at `https://localhost:8443`. Open this URL in your browser to view the dashboard.
-
----
 
-### Default Login Credentials
+3. **Access the dashboard**:  
+   Open your browser at:  
+   http://YOUR_IP/springcloud/
 
-After starting the application, you can log in with the following **default sysadmin user**:
+4. **Default credentials**:  
+   - **Username**: `sysadmin`  
+   - **Password**: Auto-generated in the console on startup
 
-- **Username**: `sysadmin`
-- **Password**: Random generated in Console on every Boot.
+5. **Uninstalling**:  
+   Run the provided `uninstall.sh` script for a clean removal.
 
 ---
 
 ## Usage
 
-1. **Login**: Enter your credentials to log into the dashboard. Admins can access the admin panel.
-2. **Upload Files**: Click the "+" button at the bottom-right of the page to upload files.
-3. **File List**: View uploaded files in a list with information like file name, type, and upload date.
-4. **File Preview**: Click "Preview" next to a file to view its contents.
-5. **Download/Delete Files**: Download or delete files by clicking the respective actions next to the file name.
+1. **Login**: Use your credentials to access the dashboard. Admins can access the admin panel.
+2. **Upload Files**: Click the "+" button to upload new files.
+3. **File List**: View files in a table with sortable columns for name, type, size, and upload date.
+4. **Preview Files**: Click "Preview" to view file contents in the browser.
+5. **Download/Delete**: Use the action buttons next to each file for download or deletion.
 
 ---
 
 ## Contributing
 
-We welcome contributions to the SpringCloud Dashboard project! If you'd like to contribute, please follow the guidelines below.
+We welcome contributions!  
 
 ### How to Contribute
 
-1. **Fork the repository**: Start by forking the repository to your own GitHub account.
-2. **Create a new branch**: Always create a new branch for each feature or bug fix you are working on. Use descriptive names for your branches (e.g., `feature/upload-improvement` or `bugfix/missing-icon`).
-3. **Write tests**: Ensure that any changes you make are covered by appropriate tests.
-4. **Submit a pull request**: Once you're done with your changes, submit a pull request to the `main` branch. Make sure to describe your changes in detail.
+1. Fork the repository  
+2. Create a new branch for your feature or fix:  
+   feature/my-new-feature  
+   bugfix/fix-issue
+3. Implement changes with tests  
+4. Submit a pull request to `main` with a detailed description
 
 ### Code of Conduct
 
-- Be respectful and considerate of others.
-- Follow the existing code style and practices of the project.
-- Submit clear, well-documented code with a detailed description of your changes.
+- Be respectful and considerate  
+- Follow the project’s code style  
+- Document your changes clearly
 
-### How to Mention or Credit Me
+### Credit the Original Author
 
-If you're using or building upon this project, I’d appreciate it if you could credit me as the original creator. A simple acknowledgment in your repository or project would be great! Here’s an example of how you can do it:
+If using or building on this project, please credit:  
+Based on the [SpringCloud Dashboard](https://github.com/verpxnter/springcloud) by [@verpxnter](https://github.com/verpxnter)
 
-- **In your `README.md`**:
-   ```markdown
-   Based on the [SpringCloud Dashboard](https://github.com/verpxnter/springcloud) by [@verpxnter](https://github.com/verpxnter).
-   ```
+---
 
 ## Reporting Issues
 
-If you encounter any bugs or have suggestions for improvements, feel free to open an issue on the GitHub repository. Please provide a detailed description of the problem and, if applicable, steps to reproduce.
+Encountered a bug or have a suggestion? Open an issue on GitHub with:  
+
+- Detailed description of the problem  
+- Steps to reproduce  
+- Screenshots or logs if applicable
+
+---
+
+**Happy file managing!**  
+— The SpringCloud Team