Skip to content

README.md

Latest commit

 

History

History
48 lines (36 loc) · 866 Bytes

README.md

File metadata and controls

48 lines (36 loc) · 866 Bytes

Feather Image Compressor

Self-hostable image compression and conversion service.

Features

  • Compress images (JPEG, PNG, WebP, AVIF, SVG input)
  • Target specific file sizes
  • Format conversion
  • Before/after comparison slider
  • Docker deployment
  • REST API for automation

Quick Start

npm install
npm run fixtures:generate
npm run dev

Open http://localhost:3000.

npm run dev uses Webpack for stability on Windows. If you want to try Turbopack, use npm run dev:turbo.

API Usage

curl -X POST http://localhost:3000/api/compress \
  -F "[email protected]" \
  -F "outputFormat=webp" \
  -F "quality=80" \
  --output compressed.webp
curl -X POST http://localhost:3000/api/convert \
  -F "[email protected]" \
  -F "outputFormat=jpeg" \
  --output converted.jpg

Development

npm test
npm run build