aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md29
1 files changed, 27 insertions, 2 deletions
diff --git a/README.md b/README.md
index 3f86b3f..5ac073c 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,30 @@
# Food-app
-This is a site under development that tells you when your lesson is, when your lunch break is and what the school lunch of the day is.
+Readme coming soon!
## Setup
-You can add a link to this site to your startup folder to always get to know when your lunch break is when you turn on your computer in school.
+If you want to set up the server, you will have to get a SSL certificate or generate one yourself. If you want to run a dedicated server that can update, you also need to add the cron jobs from crontab\_add. You must create a MySQL DB and give its login info in ../dblogin.txt. The database should have the following tables set up:
+
+CREATE TABLE shiftnames (
+ day INT,
+ id INT,
+ name VARCHAR(128) NOT NULL,
+ PRIMARY KEY (day, id)
+);
+CREATE TABLE classes (
+ course VARCHAR(6) PRIMARY KEY,
+ class VARCHAR(4)
+);
+CREATE TABLE shifts (
+ day INT,
+ shift INT,
+ course VARCHAR(6),
+ teacher VARCHAR(4),
+ class VARCHAR(4),
+ PRIMARY KEY (day, course)
+);
+CREATE TABLE devs (
+ id INT PRIMARY KEY AUTO_INCREMENT,
+ name VARCHAR(30) NOT NULL,
+ description VARCHAR(128),
+ contact VARCHAR(40)
+);