vidx

A better save for web developers.

Features

• Image Optimizations & Manipulations
• Web Optimized by default
• Simple, lightweight
• CLI and Library Support

Install

bun install -d @stacksjs/vidx

Get Started

There are two ways of using this tool: as a library or as a CLI.

Library

Given the npm package is installed:

// wip

CLI

vidx wip
vidx --help
vidx --version

Configuration

The Reverse Proxy can be configured using a vidx.config.ts (or vidx.config.js) file and it will be automatically loaded when running the reverse-proxy command.

// vidx.config.{ts,js}
import type { vidxOptions } from '@stacksjs/vidx'

const config: vidxOptions = {
  verbose: true,
}

export default config

Then run:

./vidx start

To learn more, head over to the documentation.

Testing

bun test

Changelog

Please see our releases page for more information on what has changed recently.

Contributing

Please review the Contributing Guide for details.

Community

For help, discussion about best practices, or any other conversation that would benefit from being searchable:

Discussions on GitHub

For casual chit-chat with others using this package:

Join the Stacks Discord Server

Postcardware

“Software that is free, but hopes for a postcard.” We love receiving postcards from around the world showing where vidx is being used! We showcase them on our website too.

Our address: Stacks.js, 12665 Village Ln #2306, Playa Vista, CA 90094, United States 🌎

Sponsors

We would like to extend our thanks to the following sponsors for funding Stacks development. If you are interested in becoming a sponsor, please reach out to us.

• JetBrains
• The Solana Foundation

Credits

• Chris Breuer
• All Contributors

License

The MIT License (MIT). Please see LICENSE for more information.

Made with 💙