From 911d2fc05833fb2095f3032c34063bfd6da113fa Mon Sep 17 00:00:00 2001 From: Maksymilian Jopek Date: Thu, 13 Apr 2023 18:51:09 +0200 Subject: Relicense Add features to Readme Add start scripts --- README.md | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index f89b0a3..35dd9d4 100644 --- a/README.md +++ b/README.md @@ -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 -- cgit v1.3.1