diff --git a/README.md b/README.md index 9a8d17b..65987fd 100644 --- a/README.md +++ b/README.md @@ -25,5 +25,42 @@ It uses [_Django_](https://www.djangoproject.com/) in order to create a new inte [Installation](docs/install.md) • [Configuration](docs/config.md) - + +## Quick Demo +Below all the information to start a quick demo locally using Docker, for more stable solution please follow the [Installation](docs/install.md) guide. + +1. Install `docker` and `docker-compose` ([More Info](https://docs.docker.com/engine/install/)) +2. Run the command below to start the containers +``` +docker compose up -d +``` +3. Wait until the container is ready +``` +docker logs -f verbacap-web +``` +Wait until you can see `Listening at: http://0.0.0.0:8000` + +4. Create a superadmin user using: +``` +docker exec -it verbacap-web /entrypoint.bash createadminuser +``` +Insert the user and password of the superadmin + +5. Open your browser to [http://127.0.0.1:8080/](http://127.0.0.1:8080/) + +6. Login with the superadmin credential + +7. Go to Episode -> Add Datasource -> Add Youtube Channel and insert + +**Channel Name**: Youtube Official + +**Channel URL**: https://www.youtube.com/@youtube + +-> Submit + +8. Wait a few minute to scrape the page based by your internet connection + +9. Go to "Episode" Page -> Click on "Add to Playlist" + +10. Go to Player and listen it diff --git a/compose.yaml b/compose.yaml index d42b678..15d1225 100644 --- a/compose.yaml +++ b/compose.yaml @@ -16,8 +16,7 @@ services: - ./example/psql:/var/lib/postgresql/data web: - #build: . - image: ghcr.io/mirio/verbacap:develop + image: ghcr.io/mirio/verbacap:v1.0.0 restart: always container_name: verbacap-web command: "run" @@ -36,8 +35,7 @@ services: - ./example/web:/persist celery: - image: ghcr.io/mirio/verbacap:develop - #build: . + image: ghcr.io/mirio/verbacap:v1.0.0 restart: always container_name: verbacap-celery command: "celery" diff --git a/requirements.txt b/requirements.txt index 4b9b2fa..0b77b34 100644 --- a/requirements.txt +++ b/requirements.txt @@ -59,5 +59,5 @@ pytest-django==4.5.2 # https://github.com/pytest-dev/pytest-django # ------------------------------------------------------------------------------ feedparser==6.0.10 # https://github.com/kurtmckee/feedparser beautifulsoup4==4.12.2 -yt-dlp==2023.9.24 # https://github.com/yt-dlp/yt-dlp +yt-dlp==2023.10.7 # https://github.com/yt-dlp/yt-dlp django-filter==23.3 # https://github.com/carltongibson/django-filter