https://github.com/mhdned/compiuo
Compiuo is a sample image compression image application
https://github.com/mhdned/compiuo
express nodejs postgresql prisma
Last synced: 4 months ago
JSON representation
Compiuo is a sample image compression image application
- Host: GitHub
- URL: https://github.com/mhdned/compiuo
- Owner: mhdned
- Created: 2025-02-04T15:54:10.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-02-06T22:25:23.000Z (over 1 year ago)
- Last Synced: 2025-05-29T16:41:23.649Z (about 1 year ago)
- Topics: express, nodejs, postgresql, prisma
- Language: JavaScript
- Homepage:
- Size: 68.4 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Compiuo
#### Image Compression Application
Compiuo is a sample image compression application built with **Express.js**. It allows users to upload and compress images, reducing their file size without sacrificing too much quality.
> Note: This project is intended to be a sample project for my GitHub profile and is not an official release.
## Features
- Upload images in various formats (e.g., JPG, PNG).
- Compress images to reduce file size.
- Simple and easy-to-use interface.
- Built with **Node.js** and **Express.js** for server-side functionality.
## Installation
1. Clone this repository to your local machine:
```bash
git clone https://github.com/mhdned/compiuo.git
cd compiuo
```
2. Start the application:
```bash
npm start
```
3. Open your browser and go to http://localhost:3000/v1 to use the app.
4. Create _uploads_ folder inside project folder
```bash
mkdir uploads
```
## Usage
To compress an image, simply upload it via the web interface.
The app will handle the compression and provide you with a download link to the compressed image.
## Running with Docker
You can also run **Compiuo** inside a Docker container.
> Note: This Docker setup and image are not fully completed and may require additional configuration.
1. Build the Docker image:
```bash
docker build -t compiuo:1.0.0 .
```
2. Run the container:
```bash
docker run -i -p 8000:8000 --name compiuo-app compiuo:1.0.0
```
## Technologies Used
## License
This project is licensed under the **MIT** License.