/opentextbooks

Uses APIs from Equella, LimeSurvey and Piwik to display books and book reviews

Primary LanguagePHP

#Open Textbooks

The application is currently hosted on open.bccampus.ca and is built and maintained to support the Open Textbook Project by BCcampus

The application is embedded in a WordPress environment, and while there are WP integrations, there are zero WordPress dependencies. It can be used as a standalone app.

##Requirements

  • PHP version > 5 (though has not been tested with PHP 7)

###Will be useful if you also have any instances of:

  • an instance of LimeSurvey
  • an instance of Piwik
  • an instance of WordPress
  • an instance of Equella

##Functionality This application consumes API's from

  1. A soon-to-be-open-source book repository
  2. LimeSurvey to display book reviews
  3. Piwik Analytics to access book statistics

It also

  1. creates Google Scholar metadata for each book
  2. generates a sitemap of all textbooks which integrates with Better WordPress Google XML Sitemaps
  3. pulls data from Contact Form DB
  4. waxes your neckbeard :neckbeard:

##Purpose Built to support the wide dissemination of open textbooks.

##Quick Start

  • download the zip files to a web server
  • change env.sample.php to .env.php
  • ensure apache has write permissions to cache directory and all subdirectories (cache/webform, cache/analytics, etc)
  • modify values in .env.php to connect your instances of LimeSurvey, Wordpress, Equella and Piwik

##Copyright and License Unless otherwise noted, this code is copyright (c) 2012-2016 Brad Payne, released under a GPLv3 license, or any later version

Otherwise noted:

  • PHP Class Cache licensed under BSD, (compatible with GPL)
  • PHP Class PiwikApi licensed under Apache, (compatible with GPL)
  • PHP Class LimeSurveyApi licensed under GPL, or any later version
  • PHP Class SitemapAbstract Licensed under GPLv3, or any later version
  • Bootstrap licensed under MIT, (compatible with GPL)
  • Table Sorter is dual licensed, MIT and GPL