Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
sumitst05 committed Apr 30, 2024
1 parent 2c3cf8e commit 2d4837d
Showing 1 changed file with 81 additions and 2 deletions.
83 changes: 81 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,81 @@
# shrink-it
Simple file compression platform
<p align="center">
<img src="https://img.shields.io/badge/Go-00ADD8?style=for-the-badge&logo=go&logoColor=white" alt="Go" />
<img src="https://img.shields.io/badge/HTMX-005A9C?style=for-the-badge&logo=htmx&logoColor=white" alt="HTMX" />
<img src="https://img.shields.io/badge/Tailwind_CSS-38B2AC?style=for-the-badge&logo=tailwind-css&logoColor=white" alt="Tailwind CSS" />
</p>

# 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** (Pending) :

MP3, WAV

- 🎞️ **Videos** (Pending) :

MP4, MKV

### Quick Peek:



### 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:

<a href="https://render.com" style="display: flex; align-items: center; text-decoration: none;">
<img src="https://media.licdn.com/dms/image/D4E0BAQGGDoFoqHtOvA/company-logo_200_200/0/1702595267620/renderco_logo?e=2147483647&v=beta&t=Ywm0UZpTXbiXPopyfCDty8QXSEVz88QWWCwy28qLUyE" width="60" height="60" style="margin-right: 10px;" />

<h2>Render</h2>
</a>

0 comments on commit 2d4837d

Please sign in to comment.