Add development instructions

This commit is contained in:
JovannMC 2024-11-13 19:40:22 +03:00
parent 43721904ce
commit ee01a0bb19
No known key found for this signature in database
1 changed files with 9 additions and 1 deletions

View File

@ -2,4 +2,12 @@
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](https://vert.sh).
VERT is built in Svelte and TypeScript.
This project uses Svelte & TypeScript (via [bun](https://bun.sh)).
## Development
- Clone the project - `git clone https://github.com/not-nullptr/VERT.git`
- Use [bun](https://bun.sh) to install the dependencies - `bun install`
- Copy `.env.example` to `.env` and make any changes (if wanted)
- Start a dev environment & make your changes - `bun run dev`
- Build and preview for production - `bun run build` & `bun run preview`