Quickly compress images under 100 KB
Explore the docs »

View App · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Motivation
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
   • Deployment
3. License

About The Project

Compressroar is a side-project of the BetMGM Manila CMS Team to help streamline the design process when preparing assets for production.

Motivation

Or, Why Another Image Compressor?

There are already a number of free image compressors online, but these tools often send data to external servers, which is not ideal from a security standpoint.

Also, many of these free tools don't allow designers to fine-tune the level of compression needed for each individual image.

Compressroar aims to solve these problems by providing the following features:

• 🖼️ Image compression (currently supports JPG and PNG files)
• 🎚️ Quality slider for adjusting compression level
• ✔️ Validation icons to easily spot images over 100 KB
• 🔒 All work is done in the browser, so no data is sent to a server!

(back to top)

Built With

• 
• 

(back to top)

Getting Started

Compressroar is a single-page app built with vanilla JavaScript (no framework). We use Eleventy to generate the static files, which are hosted on Netlify.

To get a local copy up and running, follow these steps:

Prerequisites

• Node
• npm

Installation

1. Clone the repo

   git clone https://github.com/joshjavier/image-compressroar.git
   cd image-compressroar

2. Install NPM packages

   npm install

3. Run Eleventy Dev Server

   npm start

Deployment

Deployments are managed by Netlify and are triggered when pull requests are merged to the main (production) and develop (staging) branches.

• develop is automatically deployed to develop--compressroar.netlify.app
• main is auto-deployed to compressroar.netlify.app

Also, Netlify automatically generates deploy previews when creating or updating pull requests to the main and develop branches. This is useful for quickly testing functionality when reviewing PRs.

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)