Browse Source

readme: Document how to run the project

master
Elis Hirwing 3 years ago
parent
commit
0fcb399960
Signed by: etu GPG Key ID: D57EFA625C9A925F
  1. 12
      README.org

12
README.org

@ -1,4 +1,16 @@
* Usage
I've provided an =.envrc= for direnv which uses =nix-shell= to load
=shell.nix= which provides the dependencies needed to run the project.
But it's not required to use =nix-shell= since the only deps are =php= of
a version 7.2 or newer and =composer=.
It's required to run =composer install= in this directory before starting
the webserver and then running the repl pointing to the webserver.
The database is a sqlite database which ends up in =sqlite.db= in the root
directory of the project.
** Run the webserver
: php -S localhost:8000 -t public/

Loading…
Cancel
Save