update readme

This commit is contained in:
dece 2024-09-01 16:37:32 +02:00
parent 69ef5e9fb3
commit 77f0562333

View file

@ -2,19 +2,16 @@
> Lightweight Symfony Broadcast Client, probably.
A small platform to create podcasts and episodes, host the audio files and share
the RSS feed, with external sources download abilities.
A small platform to create podcasts and episodes, host the audio files and share the RSS feed, with external sources download abilities.
Features include:
- Lightweight, bare minimum pages;
- Simple backoffice;
- Separate users manage their own podcasts;
- TODO an API
- TODO the API let's you quickly add whole episodes from Youtube links
- A download service to add episodes from an API or the command-line by providing a URL to download and a podcast slug; this service forwards everything to [yt-dlp](https://github.com/yt-dlp/yt-dlp) (download) and [FFProbe](https://ffmpeg.org/ffprobe.html) (metadata);
Podcasts follow mostly open standards but the “target” client is the fantastic
[AntennaPod](https://antennapod.org/), and gPodder was used in development.
Podcasts follow mostly open standards but the “target” client is the fantastic [AntennaPod](https://antennapod.org/), and gPodder was used in development.
@ -29,9 +26,7 @@ For production:
1. Clone the repository.
2. Setup your web server to use PHP-FPM (root is `./public`).
3. Create the production config file: `composer dump-env prod`. Set a proper app
secret.
4. Create a database and its owner, then set appropriate database credentials in
the config file.
3. Create the production config file: `composer dump-env prod`. Set a proper app secret.
4. Create a database and its owner, then set appropriate database credentials in the config file.
5. Install dependencies: `composer install --no-dev`.
6. Apply database migrations: `php bin/console doctrine:migrations:migrate`