dl.emersa.it/README.md

42 lines
1.3 KiB
Markdown
Raw Permalink Normal View History

2025-02-15 00:21:31 +01:00
# scaricatore
2025-02-07 20:51:51 +01:00
2025-02-14 21:42:56 +01:00
![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')
2025-02-14 20:57:22 +01:00
2025-02-15 00:50:59 +01:00
<img src='./static/screen.webp' alt='screen' height=300>
2025-02-07 20:54:10 +01:00
2025-02-14 21:03:40 +01:00
It's a svelte(kit) frontend that uses `yt-dlp` to let the user download things from the web.
2025-02-07 20:54:10 +01:00
2025-02-15 00:21:31 +01:00
## 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
2025-02-15 00:25:10 +01:00
5. Run it: `node .`
6. You can also try to configure the systemd unit file inside the `configurations` folder.
2025-02-15 00:21:31 +01:00
2025-02-15 00:25:10 +01:00
### Docker
2025-02-15 00:21:31 +01:00
2025-02-15 00:25:10 +01:00
(currently not supported)
2025-02-15 00:21:31 +01:00
2025-02-15 00:25:10 +01:00
## Development: getting started
2025-02-07 20:51:51 +01:00
- Clone the repo
- Run `npm install` (you have to have node installed)
2025-02-14 21:03:40 +01:00
- Run `npm run download-yt-dlp`
- Copy `.env.example` to `.env`
- Change `.env` to set `YTDLP_PATH` to the yt-dlp binary previously downloaded
2025-02-07 20:51:51 +01:00
- Run `npm run dev`
- Now you can write code
2025-02-15 00:21:31 +01:00
## To do:
2025-02-07 20:51:51 +01:00
2025-02-14 21:03:40 +01:00
- Proper logs (I don't like them, not useful for production build)
- Containerfile for container build
2025-02-07 20:51:51 +01:00
- Source spotify (spotdl)
2025-02-07 20:54:10 +01:00
- Parse URL info without `youtube-dl-exec`