diff options
| author | Maksymilian Jopek <maks@jopek.eu> | 2023-04-13 18:51:09 +0200 |
|---|---|---|
| committer | Maksymilian Jopek <maks@jopek.eu> | 2023-04-13 18:51:09 +0200 |
| commit | 911d2fc05833fb2095f3032c34063bfd6da113fa (patch) | |
| tree | 0db720cc3d341e28ecef36d98e68978b61b3ab06 /README.md | |
| parent | 1df1ff6f074528a4ad6d4015c794a1555c1c942f (diff) | |
| download | fia-911d2fc05833fb2095f3032c34063bfd6da113fa.tar.gz fia-911d2fc05833fb2095f3032c34063bfd6da113fa.tar.zst fia-911d2fc05833fb2095f3032c34063bfd6da113fa.zip | |
Relicense
Add features to Readme
Add start scripts
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 22 |
1 files changed, 16 insertions, 6 deletions
@@ -1,7 +1,17 @@ -# fia -Onlineversion av det klassiska brädspel "Fia" -# Start instructions +# Fia +## Onlineversion av det klassiska brädspel "Fia" + +Features: +- Classical and beloved gameplay +- Allows you to play with friends over the internet +- Disables simple cheating +- Simple UI + +## Start instructions To start: -- import /fia.sql and set database name and credentials in /public/php/ -- run `pnpm dev` in / -- and `php -S 0.0.0.0:8001` in /public/php/ simultaneously +- import /fia.sql and set database name and credentials in /public/php/dbCredentials.php +- install node modules with `pnpm install` +- set secure SESSION_KEY in /start-node +- set secure API_KEY in /public/php/dbCredentials.php +- run `start-node` in / +- and `start-php` in / simultaneously in another terminal |