You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Elis Hirwing
0fcb399960
readme: Document how to run the project
|
7 months ago | |
|---|---|---|
| public | 7 months ago | |
| src/Etu | 7 months ago | |
| .envrc | 7 months ago | |
| .gitignore | 7 months ago | |
| README.org | 7 months ago | |
| composer.json | 7 months ago | |
| composer.lock | 7 months ago | |
| repl.php | 7 months ago | |
| shell.nix | 7 months ago | |
README.org
README.org
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/
Run the repl
php repl.php http://localhost:8000
API docs
Request stock by item name
curl http://localhost:8000/inventory/item-name
Bring stock down by item name
curl -X DELETE http://localhost:8000/inventory/item-name/amount
Increase stock by item name
curl -X PUT http://localhost:8000/inventory/item-name/amount