Design Document Environment

From BOARD18 Project WIKI
Revision as of 12:14, 18 October 2015 by Rich (talk | contribs) (→‎Client Side)
Jump to navigation Jump to search
This page has been updated to comply with Release 0.3.x of BOARD18.
Design Document edit


Languages

Client Side

Javascript Library Releases
BOARD18 Release 1.3
jquery 1.11.0
jquery.contextMenu 1.6.5 Mod.
jquery.ui.position 1.10.4
sha256 2.2

Board 18 is being developed using HTML5 (with canvas), CSS 3 (to the extent currently supported) and the JavaScript standard referred to as ECMAScript 5. Various Javascript Libraries are used by BOARD18 as shown in the table to the right.

The Firefox browser is the development platform for this project. Currently Firefox version 41.x is being used. I recommend that this browser (or a later version of it) be used to run BOARD18. Other modern browsers work, but I can not debug problems using some of them.

NOTE: Canvas support is now present in most modern browsers. See Can I Use Canvas. But, at this point in the development of BOARD18, I do not have the resources to test it thoroughly in other browsers. I would be happy to accept your help in this area!

Server Side

The server side of BOARD18 will use LAMP. LAMP stands for Linux, Apache, MySQL and PHP. PHP will be the programming language. And MySQL will be the data base language. The current development environment is based on PHP version 5.3 and MySQL version 5.5.

Database

There will be no client side data base. All permanent storage will be via the server side MySQL data base. PHP will be used for all MySQL access. PHP will use the procedural style of the mysqli API to access the database.

Client/Server Communication

The client side of BOARD18 will use the XMLHttpRequest protocol to communicate with the server side. We will be using the get(), getJSON() and put() Ajax functions from the jQuery library for this.

User Interface

Board18 will accept the following user inputs: keyboard, mouse movement and mouse button clicks. Right clicks will activate a pop-up menu. The use of right clicks has the unfortunate side effect of contributing to BOARD18's incompatibility with smart phones, notebooks and other such devices. Scroll wheel events will not be used by the BOARD18 application.