Skip to content

Latest commit

 

History

History
77 lines (52 loc) · 2.86 KB

README.md

File metadata and controls

77 lines (52 loc) · 2.86 KB

VERT's logo

VERT.sh

VERT is a file conversion utility that uses WebAssembly to convert files on your device instead of a cloud. Check out the live instance at vert.sh.

VERT is built in Svelte and TypeScript.

Features

  • Convert files directly on your device using WebAssembly *
  • No file size limits
  • Supports multiple file formats
  • User-friendly interface built with Svelte

* Non-local video conversion is planned, but the daemon will be easily self-hostable to maintain privacy and fully local functionality.

Getting Started

Prerequisites

Make sure you have the following installed:

Installation

# Clone the repository
git clone https://github.com/yourusername/vert.git
cd vert
# Install dependencies
bun i

Running Locally

To run the project locally, run bun dev.

This will start a development server. Open your browser and navigate to http://localhost:5173 to see the application.

Building for Production

Before building for production, make sure you create a .env file in the root of the project with the following content:

PUB_HOSTNAME=example.com # change to your domain, only gets used for Plausible (for now)
PUB_PLAUSIBLE_URL=https://plausible.example.com # can be empty if not using Plausible
PUB_ENV=production # "production", "development" or "nightly"

To build the project for production, run bun run build

This will build the site to the build folder. You should then use a web server like nginx to serve the files inside that folder.

If using nginx, you can use the nginx.conf file as a starting point. Make sure you keep cross-origin isolation enabled.

With Docker

Clone the repository, then build a Docker image with:

$ docker build -t VERT-sh/vert \
	--build-arg PUB_ENV=production \
	--build-arg PUB_HOSTNAME=vert.sh \
	--build-arg PUB_PLAUSIBLE_URL=https://plausible.example.com .

You can then run it by using:

$ docker run --restart unless-stopped -p 3000:3000 -d --name "vert" VERT-sh/vert

We also have a docker-compose.yml file available. Use docker compose up if you want to start the stack, or docker compose down to bring it down. You can pass --build to docker compose up to rebuild the Docker image (useful if you've changed any of the environment variables) as well as -d to start it in dettached mode. You can read more about Docker Compose in general here.

License

This project is licensed under the AGPL-3.0 License, please see the LICENSE file for details.