Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sumitst05/shrink-it

Simple file compression platform using Go + HTMX
https://github.com/sumitst05/shrink-it

filecompression go htmx tailwindcss webapp

Last synced: 27 days ago
JSON representation

Simple file compression platform using Go + HTMX

Awesome Lists containing this project

README

        


Go
HTMX
Tailwind CSS

# ShrinkIt

ShrinkIt is a simple file compression platform written in Go

The UI is written in 🐴 HTMX with [a-h/templ](https://github.com/a-h/templ) and Tailwind CSS

All the compression and shrinking is performed using the Go standard library alongside some very handy and amazing CLI Tools (for now)

### Shrinks:

- 🖼️ **Images**:

PNG, JPG

- 📄 **Documents**:

PDF, DOCX

- 🎶 **Audios** :

MP3, WAV

- 🎞️ **Videos** :

MP4, MKV

### Quick Peek:

![swappy-20240430_165715](https://github.com/sumitst05/shrink-it/assets/106669732/5919fcff-a59e-425c-ac2a-bc38c9213422)

![swappy-20240430_165744](https://github.com/sumitst05/shrink-it/assets/106669732/f2b5fb5f-c9e6-4828-9e2b-5d926dd86132)

### Installation:

#### Using Docker:

1. Pull the image with:

```bash
docker pull sumitst05/shrink-it:latest
```

2. Run:

```bash
docker run -p 3000:3000 sumitst05/shrink-it
```

This starts the application and makes it accessible on port 3000.

#### Building from Source:

1. Clone the repository:

```bash
git clone https://github.com/your-repo/shrink-it.git
```

2. Navigate to the project's root:

```bash
cd shrink-it
```

3. Build and run the application:

```bash
make dev
```

### Deployed on:


Render


> Note: The deployment can support only files up to 1 MB, if you want to try uploading larger files, build from source and run locally