avalokkumar / file-compression

An efficient file compression utility built using Spring Boot, enabling users to compress and decompress files in various formats with ease.

File Compression Utility

An efficient file compression utility built using Spring Boot, enabling users to compress and decompress files in various formats with ease.

---

Overview

This project is a versatile file compression utility built using Java 11, Gradle, MySQL, and Spring. It provides a simple and efficient way to compress and decompress files in various formats, streamlining your file management tasks. Whether you need to reduce storage space or transmit data more efficiently, this utility has you covered.

---

Features

• File Compression: Compress files of different formats quickly and effectively.
• File Decompression: Easily decompress compressed files.
• User-Friendly Interface: A user-friendly command-line interface for convenient file compression and decompression.
• Configurable: Customize compression settings to suit your specific requirements.
• Logging: Comprehensive logging for monitoring and debugging.
• Secure: Protect your data with robust encryption options.
• Database Integration: Store metadata and compression history in a MySQL database.

---

Prerequisites

Before getting started, ensure you have the following installed:

• Java 11 or higher
• Gradle
• MySQL
• Spring Boot

---

Getting Started

1. Clone this repository to your local machine:

   git clone https://github.com/avalokkumar/file-compression.git

2. Build the project

   ./gradlew clean build

3. Run the application

   ./gradlew :bootRun

4. Execute the curl

   curl --location 'localhost:8080/api/compress/LZW' \ --form 'file=@"/Users/{username}/Documents/image001.png"'