Skip to content

Latest commit

 

History

History
75 lines (47 loc) · 2.4 KB

README.md

File metadata and controls

75 lines (47 loc) · 2.4 KB

caravaggio logo

Caravaggio

pipeline status coverage report

A blazing fast ⚡ image manipulation service.

Read the complete documentation at caravaggio.ramielcreations.com

Note

From version 2.x this project is ready for production. If you have still version 1.x, upgrade please. There is no migration guide since the first version was intended for test only

Installation

NPM

npm i -g caravaggio
caravaggio

Docker

An image is provided

docker pull ramielcreations/caravaggio
docker run --name caravaggio -p 8565:8565 -dti ramielcreations/caravaggio:latest

Refer to the page on the docker store for its configuration

Git

You can run caravaggio directly from the git repository, but it's meant for development purpose only.

git clone [email protected]:ramiel/caravaggio.git
cd caravaggio
npm install
npm run dev

Using the service

The service is avaiable at http://localhost:8565/

and can be used sending a set of options and an image:
http://localhost:8565/rotate:90?image=https://image.com/pony.jpg

Available operations

Please, refer to the documentation to know what are the available operations.

Thank you

This project is possible thanks to

  • sharp - A js image processing library
  • micro - A fast microservice library
  • A lot of other great developers
  • The amazing photographers on pexels.com

Licensing

This package is free to use for non-commercial purposes.
For commercial purposes it is free to use for a trial period under the terms of the Prosperity Public License.

Licenses for long-term commercial use are available via licensezero.com.

licensezero.com pricing