diff --git a/README.md b/README.md index 3f395f3..49e7f38 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -## scaricatore +# scaricatore ![version](https://git.pweapon.org/odo/dl.emersa.it/badges/release.svg 'version') ![status](https://git.pweapon.org/odo/dl.emersa.it/badges/workflows/ci.yaml/badge.svg 'status') @@ -7,6 +7,20 @@ It's a svelte(kit) frontend that uses `yt-dlp` to let the user download things from the web. +## How to Deploy + +### Node + +0. Install nodejs +1. Download the latest release from the [releases](https://git.pweapon.org/odo/dl.emersa.it/releases) page. +2. Unpack and decompress (`tar xvf build.tar.gz`) the release +3. Then `cd` into it and run: `npm ci` and `npm run build` +4. Copy `.env.example` to `.env`, and add needed variables +5. Run: `node build/` + +### Docker (currently not supported) + + ### Development: getting started - Clone the repo @@ -17,7 +31,7 @@ It's a svelte(kit) frontend that uses `yt-dlp` to let the user download things f - Run `npm run dev` - Now you can write code -### Missing +## To do: - Proper logs (I don't like them, not useful for production build) - Containerfile for container build diff --git a/scripts/src/pre-commit.sh b/scripts/src/pre-commit.sh index e92d573..b5ba712 100755 --- a/scripts/src/pre-commit.sh +++ b/scripts/src/pre-commit.sh @@ -9,4 +9,4 @@ set -e -npm run lint +npm run format