dl.emersa.it/README.md
0d0 575fdc6386
Some checks failed
Bump deps (only minor versions) / ci (push) Failing after 15s
Update readme
2025-02-25 01:14:53 +01:00

40 lines
1.3 KiB
Markdown

# 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')
<img src='./static/screen.webp' alt='screen' height=300>
It's a svelte(kit) frontend + backend that uses [`yt-dlp`](https://github.com/yt-dlp/yt-dlp) to let the user download audio/video files from the web.
## How to Deploy
### Node
- Install NodeJS
- Create a new directory (`"${PROJECT_ROOT}"`)
- run `scripts/install.sh "${PROJECT_ROOT}"`
Edit `scripts/deploy_example.sh` if you need to deploy `scaricatore` to some server using `SSH`.
### Docker
(currently not supported)
## Development: getting started
- run `git clone git@git.pweapon.org:odo/dl.emersa.it.git`
- Run `cd dl.emersa.it; npm install` (you have to have node installed)
- Run `npm run download-yt-dlp`
- Copy `.env.example` to `.env`
- Change `.env` to set `YTDLP_PATH` to the yt-dlp binary previously downloaded
- Run `npm run dev`
- Now you can write code
## To do:
- Logs (I don't like them, not useful for production build but somewhere sometime they are needed)
- Containerfile for container build
- Source spotify (spotdl)
- Parse URL info without `youtube-dl-exec`
- Dockerfile inside the forgejo release action