diff --git a/readme.md b/readme.md index 38b34928..23a73c5f 100644 --- a/readme.md +++ b/readme.md @@ -2,4 +2,38 @@ This is the code that runs my website, [jonnybarnes.uk](https://jonnybarnes.uk). -It’s not quite ready for anyone else, but it will be soon :) +In theory this is usable by other now :D + +Set up the database, this software needs PostgresQL with the postgis plugin: + +... + +First get the code, and make sure you’re on the `master` branch. This branch will +only have tagged releases: + +```shell +$ git clone https://github.com/jonnybarnes/jonnybarnes.uk mysite.com +$ cd mysite.com +$ git checkout master +``` + +Then we need to set up the environment variables that the app will use. + +```shell +$ cp .env.example .env +$ vim .env +``` + +Fill in the various variables. Then we can set up the app: + +```shell +$ composer install +$ php artisan key:generate +$ php artisan migrate +``` + +Now we need to edit some config values. In `config/app.php` edit `name`, and in +`config/syndication.php` edit it to the appropriate values or set targets to `null`. + +Now point your server to `publix/index.php` and viola. Essetnally this is a +Laravel app so debugging things shouldn’t be too hard.