imagex/openedu

Template for Drupal 8 sites built using the OpenEDU distribution.

8.3.4 2019-04-18 20:08 UTC

Requires

• acquia/lightning: ~3.2.0
• drupal/address: ^1.0
• drupal/addtoany: ^1.7
• drupal/addtocal: 1.x-dev
• drupal/admin_toolbar: ^1.18
• drupal/better_exposed_filters: ~3.0
• drupal/better_normalizers: ~1.0
• drupal/calendar: 1.x-dev
• drupal/chosen: ^2.5
• drupal/date_recur: ^1.0@alpha
• drupal/default_content: ~1.0
• drupal/facets: ~1.0
• drupal/field_group: ^1.0
• drupal/flexible_layout: ^1.0
• drupal/flickity: ^2.2
• drupal/geocoder: ^2.0@alpha
• drupal/google_analytics: ^2.2
• drupal/google_analytics_reports: ~3.0
• drupal/google_map_field: ^1.4
• drupal/lingotek: ^2.2
• drupal/link_attributes: ^1.0
• drupal/name: ^1.0
• drupal/obfuscate_email: ~1.0
• drupal/sa11y: ~1.0
• drupal/search_api_autocomplete: ~1.0
• drupal/search_api_sorts: ^1.0
• drupal/simple_sitemap: ^2.11
• drupal/twig_field_value: ^1.1
• drupal/views_block_filter_block: ~1.0
• drupal/webform: ^5.0
• drupal/yoast_seo: ~2.0
• harvesthq/chosen: ^1.8

Requires (Dev)

• drupal/coder: ~8.2.0
• drupal/console: ^1.7
• drupal/devel: ^1.0
• drush/drush: ^9.2
• phing/phing: ^2.14
• squizlabs/php_codesniffer: ~2.0

GPL-2.0-or-later

README

This is a Composer-based installer for the OpenEDU Drupal distribution.

Get Started

composer create-project imagex/openedu-project MY_PROJECT

Composer will create a new directory called MY_PROJECT containing a `docroot directory with a full OpenEDU code base. Once your webserver is pointing to thedocrootfolder, you can then install it using eitherdrush si` or via your web browser like any other drupal installation.

Post Installation

Google Maps

You must provide a valid maps api key to utilize the google mapping features used within OpenEDU. You can find the configuration at /admin/config/services/gmap-field-settings

Flexible Layout

To enable Bootstrap (or css grid) support, navigate to /admin/config/content/flexible_layout. For bootstrap, you can just enter the path to the theme css, i.e. http://yoursite.com/profiles/contrib/openedu/themes/oedu_sub/css/style.css

IXM Dashboard

The IXM Dashboard is enabled on install, but has a few requirements to be functional after installation of OpenEDU.

• Analytics

  • You will need to supply your Google Analytics tracking code at /admin/config/system/google-analytics
  • To get on-page reporting, you will need to allow the reporting API access, follow the directions at /admin/config/services/google-analytics-reports-api

• SEO

  • SEO Data will populate once the "Focus Keyword" has been entered on content.

• Accessibility

  • Accessibility checking is done using the Sa11y module. Follow the directions on the project page to obtain an API Key.

PHP Performance

The sample content contained in the OpenEDU distribution (and enabled by default) is quite large, you may need to raise your PHP `memory_limitsetting to >= 192MB and potentially yourmax_execution_time` to >= 60. Once installed, you are safe to restore these to their initial values.

Helpful Tips

• The `docroot` folder represents the web root for your site (the folder your web server points to).
• Some helpful tools can be found in the `vendor/bin` folder.
• Composer commands are always run from the site root.
• Downloading additional modules: `composer require "drupal/devel:1.x-dev"`
• Updating an existing module: `composer update drupal/devel -–with-dependencies`

Version Control

The provided `.gitignore` in the root contains all directories expected to be installed using composer.

When you first install your project, Composer will create a file called `composer.lock` that keeps track of your dependencies and which version is installed.

You want to Commit `composer.lock` ! This will ensure that anyone collaborating on the project will also install the same versions when running `composer install`