TEACH: IS1112FC Project (RNS01)

This repository contains all technical aspects of the project, including database schema dumps, HTML/PHP/CSS files and database model.

---

###Requirements

• MySQL Workbench 6.0(or above)
• MySQL 5.6
• Apache HTTP Server 2.4
• PHP 5
• Web browser with HTML5 and Javascript
• Chrome or Firefox

XAMPP contains Apache, MySQL and PHP

#####Installation Requirements

• Bower

#####Website Dependencies

• Materialize
• jQuery
• Parsedown
• MathJax
• marked

######Included in source

• CodeCogs Equation Editor

---

###Setup ####Database Model

Model file: "/db_model/TEACH.mwb"

1. Open MySQL Workbench
2. Look for the Models section
3. Open the model file as above
4. In Model -> Relationship Notation, choose UML

####Database

Database file: "/db/schema.sql"

######Option 1 (Workbench import)

1. Open MySQL Workbench and connect to your desired database
2. Click on the Management tab on the left panel and click Data Import/Restore
3. Select Import from Self-Contained File and open the database file as above
4. Click Start Import

######Option 2 (Workbench run SQL)

1. Open MySQL workbench and connect to your desired database
2. Open the database file as above in workbench (File > Open SQL Script)
3. Execute the entire script

######Option 3 (Command line)

# From system terminal 
mysql -u root -p < database_file

# From mysql terminal
source database_file

Where database_file is the path to the file as above.

####Website Sources

Location: /source

######Install Dependencies

You may install/update the required packages using Bower.

bower install
bower update

######Setup

Only do this after dependencies are installed

1. Copy the contents of the entire folder /source (not the folder itself) to to your Apache root folder.

• XAMPP Windows: C:\xampp\htdocs\
• Linux(non-XAMPP): /var/www/html/

2. Make sure Apache is running from either XAMPP or OS services.
3. Open a browser and go to the host address

• Default: http://localhost/

Remember to sync from download folder to Apache root and back when changes are made.

---

###Editing

####Database Model

Do not edit the database model concurrently, as it is a binary file and is almost impossible to merge. Only one person should edit, commit and push at any given time.

####Database

You may edit the database in your own MySQL connection, but changes will not be reflected in the database file. To update the file, you have to overwrite it with the new schema dump.

######MySQL Workbench

1. Go the the Management tab and click Data Export
2. Select Export to Self-Contained File and open the old database file to overwrite it.
3. Click Start Export

######Command Line

# From system terminal
mysqldump -u root -p > database_file

Add the following lines to the top of the file after operation exits

CREATE DATABASE  IF NOT EXISTS `TEACH` /*!40100 DEFAULT CHARACTER SET utf8 */;
USE `TEACH`;

Remember to update the model as well if you change the database tables/columns structure to avoid confusion in the future.

####Website Sources

######Framework

• Each page has a page.php and a page.layout.php
• page.php specifies the data required and page.layout.php specifies the layout
• page.php is found in pages/
• page.layout.php is found in layouts/

The main template is /templates/main.layout.php. References to website level resources as well as universal elements should be defined here.

To set up a page, use the following in page.php

require $_SERVER['DOCUMENT_ROOT']."/helpers/login.helper.php";
$loggedInUser = getLogin("all");

$pageTitle = "...";
$titleLabel = "...";

//Set up data here

$mainContent = $_SERVER['DOCUMENT_ROOT']."/page.layout.php";
include($_SERVER['DOCUMENT_ROOT']."/templates/main.layout.php");

If you need authentication, you may change getLogin("all") to adjust permissions. After that, check if $loggedInUser is set to verify if the account is present in the session. You may want to use an if statement to control the content loaded accordingly.

######Helpers

Various helpers are included in helpers/. They include various utility functions.

For example, to check if the user is logged in, we can use the getLogin() function in source/helpers/login.helper.php

require $_SERVER['DOCUMENT_ROOT']."/helpers/login.helper.php";

$loggedInUser = getLogin("staff");

if(isset($loggedInUser)){
	//Authorised content
}

######Models

Models are representations of enities in the real world and mirrors those that would be in a database.

Models can be found in source/models/. Without a database connection, data will be stored in the model itself. If not, SQL statements are found here too.

######Resources

• Materialize reference can be found here.
• Internal resources can be found in resources/
• The internal CSS rules are defined in css/main.css
• Internal Javascript components, including file uploads and previews, are found in js/
• External resources can be found in bower_components/
• e.g. Materialize: bower_components/materialize/dist/
• To install new packages, use bower install <package name> -S

---

####LaTeX and Markdown

As the editors support LaTeX forumlas and Markdown for equations and formatting respectively, the data will be stored in a combination of both where applicable.

Markdown is entered manually on the website, and is parsed by Parsedown server side (for displaying question and answer content), and by marked client side (for previews).

LaTeX equations can be entered manually (enclosed in $...$ or \[...\]), or they can be entered with the CodeCogs equation editor, found in /source/resources/js/editor.js. They are parsed client side using the MathJax Javascript library.

Becareful when dealing with LaTeX and Markdown syntax. Markdown is parsed, first, then the HTML itself, then finally the LaTeX. Escape characters must be repeated for each parse if neccessary.

---

###Credits

• Icons: Icons made by Freepik from www.flaticon.com
• Terms and Conditions was created using a Contractology template available at http://www.freenetlaw.com.