openimg - GitLite

KO | EN

gitlite — search

#javascript #python #ai #typescript #go #android #machine-learning #nodejs #java #windows #cli #mcp #ios #open-source

openimg

(★ 90)

Image optimization packages & tools

파일 탐색기

최종 버전 다운로드 (.zip)

- - tests.yml
- - bun.md
  - node.md
  - react.md
  - vite.md
- - custom-image-processing.md
  - optimizer-endpoint.md
  - optimizer-server.md
- - CHANGELOG.md
  - package.json
  - tsconfig.json
- build.sh
- - bun.lock
  - bunfig.toml
  - meta.ts
  - package.json
  - placeholder.ts
  - remote.ts
  - server-benchmark.ts
  - server-custom-data.ts
  - server-custom-sharp-pipeline-no-cache.ts
  - server-custom-sharp-pipeline.ts
  - server-fetch-remote.ts
  - server-no-cache.ts
  - server.ts
  - tsconfig.json
- - bunfig.toml
  - meta.ts
  - package.json
  - remote.ts
  - server-benchmark.ts
  - server-custom-data.ts
  - server-custom-sharp-pipeline-no-cache.ts
  - server-custom-sharp-pipeline.ts
  - server-fetch-remote.ts
  - server-no-cache.ts
  - server.ts
  - tsconfig.json
- - .gitignore
  - package.json
  - tsconfig.json
- - bunfig.toml
  - happydom.ts
  - index.test.tsx
  - matchers.d.ts
  - package.json
  - testing-library.ts
  - tsconfig.json
- - .dockerignore
  - .gitignore
  - Dockerfile
  - package.json
  - react-router.config.ts
  - tsconfig.json
  - vite.config.ts
- - benchmark-runner.ts
  - test-runner-custom-data.ts
  - test-runner-custom-sharp-pipeline-no-cache.ts
  - test-runner-custom-sharp-pipeline.ts
  - test-runner-fetch-remote.ts
  - test-runner-metadata.ts
  - test-runner-no-cache.ts
  - test-runner-placeholder.ts
  - test-runner.ts
  - utils.ts
.editorconfig
.gitignore
bun.lock
LICENSE
package.json
README.md

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/andrelandgraf/openimg

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd openimg

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Node.js

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

npm install

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

npm start

개발/실행 서버를 켭니다.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# openimg

openimg (Open Image) is a set of JavaScript packages for working with images on the web. It includes a React component, server-side code for Node and Bun, and a Vite plugin. Every part is built to work smoothly together, but you can also use them individually.

## Getting started

The easiest way to get started is to integrate openimg as an image optimization endpoint on your existing server. From there, you can utilize the React component to query for optimized images and use the Vite plugin to integrate local image assets from your Vite project. You can follow the [optimization endpoint guide](./docs/guides/optimizer-endpoint.md) for a step-by-step walkthrough.

## Use cases & guides

- [Add an image optimization endpoint to your server](./docs/guides/optimizer-endpoint.md)
- [Deploy a standalone image optimization server](./docs/guides/optimizer-server.md)
- [Custom image transformations](./docs/guides/custom-image-processing.md)

## API reference

- [openimg/bun](./docs/api/bun.md): Image optimization request handler and other utilities optimized for Bun
- [openimg/node](./docs/api/node.md): Node-compatible image optimization request handler and other utilities for Bun, Deno, and Node
- [openimg/react](./docs/api/react.md): Image React component to query for optimized images
- [openimg/vite](./docs/api/vite.md): Vite plugin for integrating local image assets from your Vite project

## Changelog

Find the changelog here: [CHANGELOG.md](./packages/core/CHANGELOG.md)

## Motivation & references

Why another image optimization package? I wanted a full-stack solution that works out of the box with minimal setup. This could have been a small wrapper around `unjs/ipx` and `unpic/image`, but I first wanted to build something from scratch and minimize dependencies (other than sharp).

The HTTP request handler is inspired by [this Gist by Jacob Ebey](https://gist.github.com/jacob-ebey/3a37a86307de9ef22f47aae2e593b56f) that showcases how to use sharp with stream processing.