{"id":26860348,"url":"https://github.com/bccampus/opentextbooks","last_synced_at":"2025-05-06T18:06:58.807Z","repository":{"id":20438459,"uuid":"23715256","full_name":"BCcampus/opentextbooks","owner":"BCcampus","description":"Uses APIs from Equella, LimeSurvey and Piwik to display books and book reviews","archived":false,"fork":false,"pushed_at":"2021-04-28T21:36:47.000Z","size":5918,"stargazers_count":3,"open_issues_count":30,"forks_count":6,"subscribers_count":14,"default_branch":"dev","last_synced_at":"2024-04-14T21:49:44.520Z","etag":null,"topics":["book-reviews","equella","limesurvey","open-textbooks","piwik","sitemap","textbook"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/BCcampus.png","metadata":{"files":{"readme":"README.md","changelog":"changelog.txt","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-09-05T19:16:29.000Z","updated_at":"2023-07-07T14:15:29.000Z","dependencies_parsed_at":"2022-07-31T19:48:12.318Z","dependency_job_id":null,"html_url":"https://github.com/BCcampus/opentextbooks","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BCcampus%2Fopentextbooks","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BCcampus%2Fopentextbooks/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BCcampus%2Fopentextbooks/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BCcampus%2Fopentextbooks/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BCcampus","download_url":"https://codeload.github.com/BCcampus/opentextbooks/tar.gz/refs/heads/dev","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246403919,"owners_count":20771526,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["book-reviews","equella","limesurvey","open-textbooks","piwik","sitemap","textbook"],"created_at":"2025-03-31T01:33:28.109Z","updated_at":"2025-03-31T01:33:34.963Z","avatar_url":"https://github.com/BCcampus.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Open Textbooks\n[![Build Status](https://travis-ci.com/BCcampus/opentextbooks.svg?branch=dev)](https://travis-ci.com/BCcampus/opentextbooks)\n\nThe application is currently hosted on open.bccampus.ca, open.campusmanitoba.ca, openlibary.ecampusontario.ca and is built and maintained to support the [Open Textbook Project](https://open.bccampus.ca/2016/06/01/the-b-c-open-textbook-project-celebrates-another-milestone-151-open-textbooks/) by [BCcampus](https://bccampus.ca/)\n- [books](https://open.bccampus.ca/find-open-textbooks/)\n- [stats](https://open.bccampus.ca/open-textbook-stats)\n- [sitemap](https://open.bccampus.ca/wp-content/opensolr/opentextbooks/sitemap.php)\n\nThe 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.\n\n## Requirements\n- PHP version \u003e 7\n\n### Will be useful if you also have any instances of:\n- an instance of LimeSurvey\n- an instance of Matomo\n- an instance of WordPress\n- an instance of Equella\n\n## Functionality\nThis application can consume API's from\n 1. [Equella](https://github.com/equella/Equella) to display books from a collection OR\n 2. [DSpace](http://dspace.org/) to display books from a collection \n 2. [LimeSurvey](https://www.limesurvey.org/) to display book reviews\n 3. [Matomo Analytics](https://matomo.org/) to access book statistics\n\nIt also\n 1. creates Google Scholar metadata for each book\n 2. generates a sitemap of all textbooks which integrates with [Better WordPress Google XML Sitemaps](https://wordpress.org/plugins/bwp-google-xml-sitemaps/)\n 3. pulls data from [Contact Form DB](https://wordpress.org/plugins/contact-form-7-to-database-extension/)\n 4. waxes your neckbeard :neckbeard:\n\n## Purpose\nBuilt to support the wide dissemination of open textbooks.\n\n## Quick Start (developers)\nUses [yarn](https://yarnpkg.com/en/) to build front end dependencies and [composer](https://getcomposer.org/) to build php dependencies. Once you've cloned the repo, you'll need to build:\n- `yarn \u0026\u0026 yarn build` \n- `composer install`\n\n### THEN:\n- rename `config/environments/env.sample.php` to `.env.mydomain.com.php` \n- add config files per domain (ie. `.env.localhost.php`, `.env.myotherdomain.com.php`)\n- modify config values to connect your instances of LimeSurvey, Wordpress, Equella and Matomo\n- to test how the app will behave with a configuration file that is different than the domain you're testing with, use the override in `env.php` at the root of the site.\n- ensure the web server user (apache, _www) has write permissions to `cache` directory and all subdirectories (`cache/webform`, `cache/analytics`, etc)\n\n## Copyright and License\nUnless otherwise noted, this code is copyright (c) 2012-2016 Brad Payne, released under a [GPLv3 license](https://www.gnu.org/licenses/gpl.html), or any later version\n\nOtherwise noted:\n- PHP Class `Cache` licensed under BSD, (compatible with GPL)\n- PHP Class `SitemapAbstract` Licensed under GPLv3, or any later version\n- Bootstrap licensed under MIT, (compatible with GPL)\n- Table Sorter is dual licensed, MIT and GPL\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbccampus%2Fopentextbooks","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbccampus%2Fopentextbooks","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbccampus%2Fopentextbooks/lists"}