Skip to content

adamazad/bildx

main
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

BildX

Tests status

The self-hosted version of imgix for micro projects. PRs are welcome.

Getting started

Install from via npm

$ npm i bildx

Create a instance, and call start. Put images in storage

import BildX from "bildx"
import { resolve } from "path"

const BILDX_PORT = process.env.BILDX_PORT || 4000

const bildx = new BildX({
  storage: new BildXStorage(resolve("./storage")),
  cache: new BildXStorage(resolve("./cache")),
})

bildx.start(BILDX_PORT).then(() => console.log(`BildX deployed on ${BILDX_PORT}`))

Note: BildX.Storage throws an error if path is not absolute.

APIs

Currently, BildX supports:

  • width
  • height
  • fill
  • blur

Tests

$ npm test

WIP

  • Implement all the APIs imgix provides
  • Support for S3 and/or Firebase Storage

About

A self-hosted version of imgix built on top of Express.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published