Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ramiel/caravaggio

A blazing fast ⚡ image manipulation service. This repo is a mirror of https://gitlab.com/ramiel/caravaggio
https://github.com/ramiel/caravaggio

duotone image image-manipulation image-processing javascript proxy resize serverless sharp typescript vips webp

Last synced: 28 days ago
JSON representation

A blazing fast ⚡ image manipulation service. This repo is a mirror of https://gitlab.com/ramiel/caravaggio

Host: GitHub
URL: https://github.com/ramiel/caravaggio
Owner: ramiel
License: other
Created: 2019-06-28T08:02:23.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2024-08-22T09:53:17.000Z (4 months ago)
Last Synced: 2024-11-14T17:51:16.125Z (29 days ago)
Topics: duotone, image, image-manipulation, image-processing, javascript, proxy, resize, serverless, sharp, typescript, vips, webp
Language: TypeScript
Homepage: https://caravaggio.ramielcreations.com
Size: 17.4 MB
Stars: 25
Watchers: 5
Forks: 6
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

awesome-blazingly-fast - caravaggio - A blazing fast ⚡ image manipulation service. This repo is a mirror of https://gitlab.com/ramiel/caravaggio (TypeScript)

README

# Caravaggio

[![pipeline status](https://gitlab.com/ramiel/caravaggio/badges/master/pipeline.svg)](https://gitlab.com/ramiel/caravaggio/commits/master)
[![coverage report](https://gitlab.com/ramiel/caravaggio/badges/master/coverage.svg)](https://gitlab.com/ramiel/caravaggio/commits/master)

A blazing fast ⚡ image manipulation service.

Read the complete documentation at [caravaggio.ramielcreations.com](https://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](https://store.docker.com/community/images/ramielcreations/caravaggio) 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](https://caravaggio.ramielcreations.com) to know what are the available operations.

## Thank you

This project is possible thanks to

- [sharp](http://sharp.pixelplumbing.com/en/stable/) - A js image processing library
- [micro](https://github.com/zeit/micro) - A fast microservice library
- A lot of other great developers
- The amazing photographers on [pexels.com](https://www.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](./LICENSE).

Licenses for long-term commercial use are available via [licensezero.com](https://licensezero.com).

[![licensezero.com pricing](https://licensezero.com/projects/0409c5bf-201d-49dd-af6e-2aa5169cf15a/badge.svg)](https://licensezero.com/projects/0409c5bf-201d-49dd-af6e-2aa5169cf15a)