aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorarf20 <aruizfernandez05@gmail.com>2024-03-15 17:29:02 +0100
committerarf20 <aruizfernandez05@gmail.com>2024-03-15 17:29:02 +0100
commit7377f6cd21d1069d4392c16bf0d13e3f8b0b8375 (patch)
treec69ef347834dce75a3f58993b12cd6d64da92381 /README.md
parent8bca2f7e966883cd1e73bf8df384a0aa21a271ba (diff)
downloadarfnet2-cstims-7377f6cd21d1069d4392c16bf0d13e3f8b0b8375.tar.gz
arfnet2-cstims-7377f6cd21d1069d4392c16bf0d13e3f8b0b8375.zip
Design
Diffstat (limited to 'README.md')
-rw-r--r--README.md41
1 files changed, 40 insertions, 1 deletions
diff --git a/README.md b/README.md
index ce1811d..e5241f3 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,41 @@
# arfnet2-cst
-ARFNET2 Customer, Service manager and Ticketing system
+ARFNET2 Client, Service manager and Ticketing system
+
+```
+User types:
+ Admin: user, service and ticket management
+ Helpdesk: read, answer and close tickets only
+ Client: order services and open tickets
+
+Report problems with CST or such as password changes to admin@arf20.com
+
+FILES:
+ register.php -> login.php
+ registers client to db
+ send email with verification link
+ login.php -> { client.php, helpdesk.php, admin.php }
+ checks creds against db and starts session
+ checks user type for location
+ logout.php -> login.php
+ stops session
+
+ client.php -> { order.php, openticket.php }
+ shows ordered services and opened tickets
+ helpdesk.php
+ view and close tickets
+ admin.php
+ manage users, services and tickets
+
+SQL:
+Database: arfnet2
+Tables:
+ users User logins
+ id autoincrement, username, password (hash), email, email verification code, user type { client, helpdesk, admin }, register date
+ services Available services and management notes etc
+ id autoincrement, name, type, billing, description
+ orders
+ id autoincrement, service id, instance name, client id, comments
+ tickets List of tickets
+ id autoincrement, client id, title, body, status { open, closed, nofix }
+
+```