Skip to content
Snippets Groups Projects
Commit 63b0dc4d authored by Eric Bremner's avatar Eric Bremner
Browse files

ISTWCMS-3691: updating README to match current instructions

parent 3c72ac9a
No related branches found
No related tags found
7 merge requests!433ISTWCMS-6296 Create test for all event dates test cases,!136Istwcms 4725 ebremner config sync,!63Feature/istwcms 4512 l26yan add first last name fields to users,!48Feature/istwcms 4465 l26yan remove paragraphs edit from base profile,!9Feature/istwcms 4139 l26yan update leaflet,!8Feature/istwcms 4156 l26yan set up catalogs terms,!2Feature/istwcms 4137 ebremner use linkit
## NOTE ON THEMEING
# UW base Profile: Drupal 8 + PatternLab
With the release of Drupal 8.6.0 WCMS theme uw_fdsu_theme_resp would not install
correctly in the profile. For now, it has been removed, once the profile
installs, you can simply enable the theme either through the command line or the
GUI.
Built from [Drupal 8 core](https://drupal.org) and [Gesso](https://www.drupal.org/project/gesso) using the code from [Fourm One](https://www.forumone.com/) and the [git hub repository](https://github.com/forumone/gesso).
## Installation
## Requirements
Run:
1. [Node](https://github.com/creationix/nvm)
- currently version 12.16.1
2. [Gulp](http://gulpjs.com/)
- currently version 4.0.2
3. [Composer](https://getcomposer.org/)
- currently version 1.10.1
* ./rebuild.sh
* ./themes/uw_fdsu_theme_resp/setuptheme.sh
## Notes on theming
UW has taken the approach to use a component based design and has chosen [Fourm One's](https://www.forumone.com/) pattern-lab instance of [Gesso](https://www.drupal.org/project/gesso) from the [git hub repository](https://github.com/forumone/gesso).
## Locally-modified modules
When installing the base profile for the FIRST time you must install both the profile and gesso. On subsequent installs you may chose to bypass installing gesso, however, if there are updates to gesso, those will be missed.
## Installing the profile and/or gesso
UW FDSU responsive theme comes with a script that will handling building the theme and/or gesso.
## Rebuild script
./rebuild.sh will accept the following switches:
1, 2 or 3 (like build-option, can use either or)
1 = rebuild profile only
2 = rebuild profile and gesso
3 = rebuild gesso only
--build-option [#] (required)
1 = rebuild profile only
2 = rebuild profile and gesso
3 = rebuild gesso only
--gesso-branch-tag [branch/tag] (optional)
Provide a Git branch or tag name for uw_wcms_gesso.
Defaults to 8.x-3.x branch.
## Usage with parameters
./rebuild.sh --build-option=2 --gesso-branch-tag=8.x-3.x
./rebuild.sh 2 --gesso-branch-tag=8.x-3.x
## Usage without parameters
If you simply use ./rebuild.sh then interactivity will begin and ask questions about the build options and gesso branch/tag. If you use at least one switch then there is no interactivity.
Example with interactivity
What would you like to do?
1 = Rebuild profile only.
2 = Rebuild profile and gesso.
3 = Rebuild gesso only.
[x] Exit and do nothing
Build option [1]: 2
Gesso branch/tag: [8.x-3.x]:
## Using Pattern-Lab
Once the rebuild is completed, you can visit pattern-lab at: https://<site-name>/profiles/uw_base_profile/themes/uw_fdsu_theme_resp/uw_wcms_gesso/gesso/pattern-lab.
EXAMPLE:
https://d8alt/fdsu1/profiles/uw_base_profile/themes/uw_fdsu_theme_resp/uw_wcms_gesso/gesso/pattern-lab
If you are doing development, simply navigate in a terminal <drupal-core-path>/profiles/uw_fdsu_theme_resp/uw_wcms_gesso/gesso and run gulp
EXAMPLE:
cd /var/www/drupal8/profiles/uw_fdsu_theme_resp/uw_wcms_gesso/gesso
gulp
## Locally-modified modules
imageMagick 8.x-2.x-beta1-uw_wcms
* Base: 8.x-2.0-beta1
* Patch 60b739: Fix Animated GIF resizing.
- Base: 8.x-2.0-beta1
- Patch 60b739: Fix Animated GIF resizing.
https://www.drupal.org/node/1802534#comment-12246133
## Testing
components 8.x-2.0-beta1-uw_wcms1
- Base: 8.x-2.0-beta1
- Patch 3761f753: Fix core requirements. https://www.drupal.org/project/components/issues/3100006#comment-13385658
eck 8.x-1.0-alpha5-uw_wcms1
- Base: 8.x-1.0-alpha5
- 801e43d9: Patching updates after 8.7 drupal core
To prepare a Drupal install for testing with PHPUnit, copy
DRUPAL_ROOT/core/phpunit.xml.dist to phpunit.xml and in that file set:
samlauth 8.x-3.0-alpha1-uw_wcms3
- Base: 8.x-3.0-alpha1
- Patch 4a4b894d: fixing event subscribers. https://www.drupal.org/project/samlauth/issues/2925171#comment-12351528
webform 8.x-5.6-uw_wcms2
- Base: 8.x-5.6
- 5752fc4a: allow webform libraries to use our repos
- cc6728b1: fix version numbers
## Testing
To prepare a Drupal install for testing with PHPUnit, copy DRUPAL_ROOT/core/phpunit.xml.dist to phpunit.xml and in that file set:
SIMPLETEST_BASE_URL to the BASE_URL for your site.
SIMPLETEST_DB to the database URL following the pattern in the file.
SYMFONY_DEPRECATIONS_HELPER to "weak".
SIMPLETEST_BASE_URL to the BASE_URL for your site.
SIMPLETEST_DB to the database URL following the pattern in the file.
SYMFONY_DEPRECATIONS_HELPER to "weak".
Tests can be run from the Drupal UI. To run tests from the command line, run
this in the DRUPAL_ROOT:
Tests can be run from the Drupal UI. To run tests from the command line, run this in the DRUPAL_ROOT:
sudo --user www-data vendor/bin/phpunit -c core <test-file>
sudo --user www-data vendor/bin/phpunit -c core
Where <test-file> is like:
profiles/uw_base_profile/tests/src/Functional/UwWcmsBasicTest.php
Where is like: profiles/uw_base_profile/tests/src/Functional/UwWcmsBasicTest.php
Tests need to run with sudo because they need to run as the user that runs the
web server.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment