8.x ERCore Installation

Drupal 8 ERCore Installation Guide


document assumes Drupal 8 installation with Composer

Document layout:

Install prerequisite software for ERCore

php-zip extension, git

sudo apt-get install php-zip git

Download and Install Epscor ERCore

(https://www.drupal.org/project/ercore/)

recommended to install in project directory (example: /var/www/my-project/ or /var/www/project-root).

composer require 'drupal/ercore:^1.0'

Verification, Installation, and Update of ERCore modules from GUI

Installation (manage/extend/ercore)
You can verify that ERCore has been successfully added by viewing the extend page. There should be 4 extensions:
  1. ERCore (All Modules)
  2. ERCore Bartik
  3. ERCore Summary Views
  4. Ercore: User Profiles

To install each module, check the boxes and scroll to the bottom of page. click install

Verification (/administration/configuration/development/features )

You can verify that these modules have been installed by changing your Bundle to ERCore in the drop down menu.

NOTE: You may need to install Features UI under (extend/development) if not done already, otherwise
features will not show up under development in configuration.

Update (administration/configuration/development/features/differences)

To check for differences and changes to the running configuration, you can check the state of a feature under the
column state which will provide you with notes such as Changed, and New detected.

To update all differences click on the Differences tab under Features
and check the box next to All Differences in Bundle: ERCORE. Scroll to the bottom of the
page and click Import Changes.

ERCore module and theme setup

Download and install Bootstrap (administration/appearance)

navigate to (https://www.drupal.org/project/bootstrap) or search for
bootstrap on Drupal’s website (www.drupal.org)

composer require 'drupal/bootstrap:^3.20'

Navigate back to your website. Bootstrap will now show up in uninstalled themes. click install.

Clone and install ercore_boot from EPSCoR (project-root/web/themes/contrib)

(https://github.com/EPSCoR/ercore_boot)

sudo git clone https://github.com/EPSCoR/ercore_boot.git

Clone and install ERCore theme module (project-root/web/modules/contrib)

(https://github.com/EPSCoR/ercore_theming)

sudo git clone https://github.com/EPSCoR/ercore_theming.git

Install ERCore Bootstrap in Drupal (administration/appearance)

Navigate back to the website and under uninstalled themes, ERCore Bootstrap will
be a selection. Click install and set as default.

Next navigate to (administration/extend/ercore )and check the box next to ERCore Theming.
Scroll to the bottom of the page and click install.

Basics

ERCore Administration (admin/config/ercore/adminsettings)

Add Start Date, EPSCoR Grant Number, and other information. This information will
come from the jurisdiction. The start date specifically should be added before any significant data is added.
The Reporting period start month may be the month the grant starts, but in some jurisdictions this date
is offset. In a new grant, the default values for Grant type and Grant extension
will be correct. Later in a grant cycle, these values may be changed.

ERCore Date Filter (admin/config/ercore/date-filter)

This isn’t required and will actually change per user based on values set on summary pages.

People

Permissions (admin/people/permissions)
The default user permissions should go a long way towards setting up a site, but it is often necessary to make
adjustments. After structure and before adding users and data is a good time to get this mostly nailed down.
Tweaking permissions over time is often necessary, but getting the basics right early is good.
Default roles can be altered, but it is often easier to add additional roles to complement the default ones. This
simplifies exporting customization into new Features or just exported configuration.

Data

Start with creating Institutions. Specifically you want to add your participating Institutions, because these are the
ones necessary for adding People.Taxonomy terms should be added next. (admin/structure/taxonomy) Components, Programs, and Boards and Committees
should be added as they are necessary for adding user data.
Users are next. Adding Site Administrators and Administrative Staff Users first can be helpful. Once they are added,
those users can login and assist with test permissions and/or adding people and content. It is important that users
who will be associated with data complete their profiles. It can be confusing to try to manage data when incomplete
users are attached to data.

It’s time for data. Everything should be in place to add any ERCore data.