dece/LSBC
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

update readme

Browse source
This commit is contained in:
dece 2024-09-01 16:37:32 +02:00
parent 69ef5e9fb3
commit 77f0562333
1 changed files with 5 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

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