Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
thehowl committed Mar 4, 2018
1 parent 6ddfddb commit 75927d5
Showing 1 changed file with 22 additions and 2 deletions.
24 changes: 22 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,31 @@
>and a little baby tomato. Baby tomato starts lagging behind. Poppa tomato gets
>angry, goes over to the baby tomato, and smooshes him... and says, 'ketchup!'
Misirlou's simple PHP backend. The juicy stuff is mostly in methods.
Misirlou is Ripple's system for managing tournaments. This is the API/backend,
and why write it in PHP, you may ask? Because I thought that the thing wouldn't
have grown and that writing a few PHP files would have been enough. What a fool!

To get started, simply copy config.sample.php to config.php, and edit the
values in `$config`. Everything should be pretty obvious and need no
explanation.

Done that, create/update the database schema by running from the command line
`migrate.php`.
`migrate.php`. Finally, create an nginx config so that all requests are routed
to /router.php:

```nginx
server {
autoindex on;
listen 80;
server_name quarterpounderwithcheese.org;
root /home/howl/oc/misirlou-api;
charset utf-8;
location / {
try_files $uri $uri/ /router.php;
}
include php;
}
```

(The configuration above is actually not recommended in production - you should
at least remove the autoindex.)

0 comments on commit 75927d5

Please sign in to comment.