Add basic readme

This commit is contained in:
dece 2023-05-13 02:08:57 +02:00
parent 40f91c8d1d
commit bd12da0a7f

26
README.md Normal file
View file

@ -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`