vialab / modular

Modular web interface modules, created and maintained by Chris Kim ([e-mail])

Modular

Modular web interface modules, created and maintained by Chris Kim ([e-mail])

License

IMPORTANT: Modular is under an Academic and Non-Commercial Research Use License. Before proceeding, please be aware of the license. If you do not qualify to use Modular, you can ask to obtain permission as detailed in the license.

Live Example

The most up-to-date version of the interface is available at http://commonsense.ckprototype.com/.

Server Requirement(s)

• Ubuntu (16.04 LTS)
• Apache
• PHP 7
• MySQL

We recommend using tasksel (refer to this Linode tutorial) to install all of the above. If you are looking to set this up on Windows or macOS, you may use WAMP or MAMP installers.

Client Requirement(s)

• HTML5-complaint browser (Google Chrome)

Server Configuration Notes

PHP (php.ini)

• Short tags must be enabled (https://stackoverflow.com/questions/2185320/how-to-enable-php-short-tags)
• If you plan to upload large files, upload limit must be disabled (https://stackoverflow.com/questions/2184513/change-the-maximum-upload-file-size)

Directory

• /cache and /assets folder must be writable by PHP

If there are any other issues, you should be able to self-diagnose by investigating the Apache error logs.

Instructions

1. Load the Apache server (ex. /var/www) with the latest copy of the interface
2. Upload the provided table schema and accompanying sample data (schema.sql) to MySQL database
3. Update /library/db.php with correct MySQL credentials
4. Launch the browser and access the root directory

Sample Data

The interface contains a simple "hello world" page that illustrates the placement of individual modules.

Contact Information

Found any bugs? Please report any issues via Github's Issues feature. For private inquiry, please reach out to [e-mail].