diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 59 |
1 files changed, 52 insertions, 7 deletions
@@ -9,9 +9,9 @@ git clone "https://github.com/JoelHMikael/FoodJS.git" ## Install node.js (16.x, the one in Ubuntus package repositories is outdated) ``` -apt install curl +sudo apt install curl curl -fsSL https://deb.nodesource.com/setup_16.x | sudo -E bash - -apt-get install -y nodejs +sudo apt-get install -y nodejs ``` Install npm packages required for project ``` @@ -20,13 +20,13 @@ npm install mysql2 ## Install MySQL server & configure it ``` -apt install mysql-server +sudo apt install mysql-server sudo mysql_secure_installation ``` > Note: If you want to update the databases remotely, you can allow logging in from the local network. In this case you of course have to use a strong password. ## Initializing the database -Log into mysql and run the following to initialize the tables: +If you don't have a backup of the database and need to initialize it, log into mysql and run the following to initialize the tables: ``` CREATE DATABASE lyllruoka; USE lyllruoka; @@ -53,7 +53,7 @@ CREATE TABLE devs ( id INT PRIMARY KEY AUTO_INCREMENT, name VARCHAR(30) NOT NULL, description VARCHAR(128), - contact VARCHAR(40) + contact VARCHAR(40) DEFAULT '' ); CREATE TABLE stats ( start DATE PRIMARY KEY, @@ -68,13 +68,58 @@ CREATE TABLE exams ( PRIMARY KEY (start, end) ); ``` +> Note that if you had some information in a former database that you don't update manually, it will be lost. ## Give the server the credentials, keys & other required things * MySQL credentials in `../dblogin.txt` - * You may want to create a user for this. There has been some problems logging in as root on ubuntu, if I remember right. + * You probably should [create a user](https://dev.mysql.com/doc/refman/8.0/en/create-user.html) and [grant privileges to it](https://dev.mysql.com/doc/refman/8.0/en/grant.html) for this. For me logging in as root didn't work out of the box, except of course combined with `sudo`, which does neither work out of the box with node.js. + * The credentials should be in json format. For instance: + ``` + { + "host": "localhost", + "user": "exampleuser", + "password": "password123", + "database": "lyllruoka" + } + ``` * SSL certificate in `../Certificate/key.pem` and `../Certificate/cert.pem` + * As on the [website of node.js](https://nodejs.org/en/knowledge/HTTP/servers/how-to-create-a-HTTPS-server/), you can create a self-signed certificate (for testing purposes) as following: + ``` + openssl genrsa -out key.pem + openssl req -new -key key.pem -out csr.pem + openssl x509 -req -days 9999 -in csr.pem -signkey key.pem -out cert.pem + rm csr.pem + ``` --- # Updating the tables -Coming soon...
\ No newline at end of file + +## Shifts and classes +This is an example on how to update the shifts and classes to the database, so that the server can serve them to the clients. + +Lets assume the following filesystem that contains also all of the server code: +``` +shifts.txt +Classes +| oldclasses.txt +| newclasses.txt +``` +Where shifts.txt contains the shifts, `oldclasses.txt` contains the classes of the old curriculum and `newclasses` the classes of the new learning curriculum. + +You can get the shifts from junu's food shift message through Wilma. The classes should be tab delimited text files. You can get them easily by copy-pasting them from the eg. LibreOffice from "Kurssitarjottimet". Provide only the classes of one period, not all of them. + +Then just run the following code in node.js: +``` +const updateDB = require("./update.js"); +const openFile = require("./Functions/open.js").file; +const dbcredentials = await openFile("../dblogin.txt"); +await updateDB.update("./shifts.txt", ["./Classes/oldclasses.txt", "./Classes/newclasses.txt"], dbcredentials); +``` + +## Updating the developer table +Updating the developer table is pretty straightforward. You just need to provide the name of the developer, a description (eg. "Improved the performance of the server") and contact information: +``` +INSERT INTO devs (name, description, contact) VALUES ('[name]', '[description]', '[contact]'); +``` +> Insert the values in the quotation marks, don't change the text before the `VALUES` keyword.
\ No newline at end of file |