/micro-image

Primary LanguageTypeScript

Warning

This set of package is still in development, not meant to be used at the time being.

micro-image

This project is a multi-package with 2 main components:

  • A self-hosted image proxy, meant to cache and compress images
  • An image component (currently for React), that uses an image proxy to render the correctly

Future plans

  • Supporting (already partly implemented) multiple image proxy providers, like ipx (already supported), imgproxy, cloudinary.
  • Providing components for various front-end frameworks.
  • Providing the image proxy as a service

Usage

Coming soon :)

Apps and Packages

  • cache: image proxy powered by Fastify
  • docs: A placeholder documentation site powered by Next.js
  • @micro-image/image: React image component
  • @micro-image/utils: shared React utilities
  • @micro-image/tsconfig: shared tsconfig.jsons used throughout the monorepo
  • eslint-config-micro-image: ESLint preset

Each package and app is 100% TypeScript.

Useful commands

  • npm run build - Build all packages, the image proxy and docs site
  • npm run dev - Develop all packages, the image proxy and the docs site
  • npm run lint - Lint all packages
  • npm run changeset - Generate a changeset
  • npm run clean - Clean up all node_modules and dist folders (runs each package's clean script)