diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..7eea76b --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# digitigrade + +an experimental server for the also-experimental pawpub federated social media +protocol. + +## running the server + +**it is not in a usable state yet!** nothing useful will happen by running it, +unless you're working on it. + +you should have: + +* php >= 8.3 +* composer +* a postgres server, database and user already set up +* a beanstalkd server already running + +the basic steps for setup are: + +1. run `composer install` +2. edit config.ini as appropriate +3. set up the database with `bin/migrate` +4. run the development server with `php -S 0.0.0.0:8080 index.php` or set it up + with fpm in your web server +5. run at least one worker with `bin/worker` + +you can poke around with `bin/shell` which will launch the interactive php +shell and initialise all the composer autoloads and so on |