Skip to content

Latest commit

 

History

History
68 lines (42 loc) · 1.62 KB

README.md

File metadata and controls

68 lines (42 loc) · 1.62 KB

Compressy

Compressy is a web application that allows users to compress and resize images easily. It helps in reducing the file size of images while maintaining reasonable quality.

Features

  • Image Compression: Compress images to reduce file size.
  • Image Resizing: Resize images to specific dimensions.
  • Supported Formats: Supports popular image formats like JPG, JPEG, and PNG.
  • Preview: View original and compressed images side by side.
  • Download: Download the compressed image.

Getting Started

Prerequisites

  • Node.js installed on your machine
  • Package manager (npm or yarn)

Installation

  1. Clone the repository:

    git clone https://github.com/0ME9A/compressy.git
  2. Navigate to the project directory:

    cd compressy
  3. Install dependencies:

    npm install

Usage

  1. Start the development server:

    npm run dev
  2. Open your browser and visit http://localhost:3000.

Contributing

We enthusiastically welcome contributions from the community! Here's how you can contribute:

  1. Fork the repository.
  2. Create a new branch for your changes.
  3. Implement your modifications in the created branch.
  4. Submit a pull request with a comprehensive description of your alterations.

Before contributing, kindly review our Contributing Guidelines and Code of Conduct for a smooth collaboration.

License

This project is licensed under the MIT License.

Acknowledgments