From bd12da0a7f372d7c4998e38cee6fa82a28de6557 Mon Sep 17 00:00:00 2001 From: dece Date: Sat, 13 May 2023 02:08:57 +0200 Subject: [PATCH] Add basic readme --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..ad6339a --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +LSBC +==== + +A small platform to create podcasts and episodes, host the audio files and share +the RSS feed, with external sources download abilities. + + + +Install +------- + +This project requires: + +- PHP 8 +- PostgreSQL 15 and its PHP driver + +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. +5. Install dependencies: `composer install --no-dev`. +6. Apply database migrations: `php bin/console doctrine:migrations:migrate`