Basic image example
After pnpm install, run this from the package repository root. It writes renditions plus result.json.
pnpm --filter @renditionkit/basic-example start ./photo.jpg ./outputView source ↗RENDITIONKIT / EXAMPLES
See the pipeline
in a running app.
Two examples ship in the package repository: a small local-file processor and a complete Docker deployment with an upload API, queue, database, storage, and worker. Run these commands after cloning the package repository.
Docker reference app
Express upload and status API, PostgreSQL repository, Redis/BullMQ queue, MinIO storage, and a separate Sharp worker.
cd examples/reference && docker compose up --buildView source ↗NEW HERE?Start with the quick start ↗