https://github.com/stacksjs/vidx
📹 Make your videos load faster. A better save for the web.
https://github.com/stacksjs/vidx
cli ffmpeg library typescript video video-compression video-converter web-optimized
Last synced: about 2 months ago
JSON representation
📹 Make your videos load faster. A better save for the web.
- Host: GitHub
- URL: https://github.com/stacksjs/vidx
- Owner: stacksjs
- License: mit
- Created: 2025-01-25T18:09:29.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-03-17T15:11:09.000Z (about 2 months ago)
- Last Synced: 2025-03-17T23:23:35.104Z (about 2 months ago)
- Topics: cli, ffmpeg, library, typescript, video, video-compression, video-converter, web-optimized
- Language: TypeScript
- Homepage: https://stacks-vidx.netlify.app
- Size: 456 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
[![npm version][npm-version-src]][npm-version-href]
[![GitHub Actions][github-actions-src]][github-actions-href]
[](http://commitizen.github.io/cz-cli/)
# vidx
> A better save for web developers.
## Features
- Image Optimizations & Manipulations
- Web Optimized by default
- Simple, lightweight
- CLI and Library Support
## Install
```bash
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:
```ts
// wip
```
### CLI
```bash
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.
```ts
// vidx.config.{ts,js}
import type { vidxOptions } from '@stacksjs/vidx'
const config: vidxOptions = {
verbose: true,
}
export default config
```
_Then run:_
```bash
./vidx start
```
To learn more, head over to the [documentation](https://reverse-proxy.sh/).
## Testing
```bash
bun test
```
## Changelog
Please see our [releases](https://github.com/stacksjs/stacks/releases) page for more information on what has changed recently.
## Contributing
Please review the [Contributing Guide](https://github.com/stacksjs/contributing) for details.
## Community
For help, discussion about best practices, or any other conversation that would benefit from being searchable:
[Discussions on GitHub](https://github.com/stacksjs/stacks/discussions)
For casual chit-chat with others using this package:
[Join the Stacks Discord Server](https://discord.gg/stacksjs)
## 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](https://www.jetbrains.com/)
- [The Solana Foundation](https://solana.com/)
## Credits
- [Chris Breuer](https://github.com/chrisbbreuer)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [LICENSE](https://github.com/stacksjs/stacks/tree/main/LICENSE.md) for more information.
Made with 💙
[npm-version-src]: https://img.shields.io/npm/v/@stacksjs/vidx?style=flat-square
[npm-version-href]: https://npmjs.com/package/@stacksjs/vidx
[github-actions-src]: https://img.shields.io/github/actions/workflow/status/stacksjs/vidx/ci.yml?style=flat-square&branch=main
[github-actions-href]: https://github.com/stacksjs/vidx/actions?query=workflow%3Aci