Skip to content

yurplan/piccolo

Repository files navigation

Piccolo

Dependency Status devDependency Status Build Status Coverage Status

An image optimization API

API Documentation

Endpoint /optimization

  • Body
    • image: The binary image (50 MB max.) required
    • mode: The optimize mode (aggressive, mid, shy) defaults to mid

Usage

Docker

docker build -t piccolo .
docker run -p 3000:3000 -it piccolo

Standard

npm install
npm start

Todo

v1.0.0

  • Add tests and CI
  • Write some documentation on a Github page
  • Add Dockerfile
  • Publish the Docker image

v1.1.0

  • Add configuration file
  • Add the resizing feature

Thanks