aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 4 insertions, 17 deletions
diff --git a/README.md b/README.md
index 035059c..cb0735d 100644
--- a/README.md
+++ b/README.md
@@ -14,25 +14,12 @@ There is an included testing environment. Requirements are Docker and PHP.
Docker is generally not needed, you can replace it with any other DB Server.
PHP has to have the `pdo_mysql` driver enabled.
-```sh
-# start mariadb
-cd ./backend/docker-test-env/
-docker compose up -d
-
-# start api
-cd .. #./backend/
-php -S localhost:8000
-
-# start frontend
-cd ../frontend/
-npm i
-npm run dev
-```
-
-You send requests to the API like this:
+There is an included tmux script that starts all of the required servers.
+If you have a slightly different set up or you did not install the dependencies,
+it might still be relevant to find out what is to be done.
```sh
-curl -X POST -d '{ "key": "value" }' http://localhost:8000/yourapifile.php
+./tmux.sh
```
`index.php` automatically creates the required database tables if they do not already exist, so just request that API to have everything set up for you.