README.md 2.71 KB
Newer Older
1
# UW base Profile: Drupal 8 + PatternLab
Liam Morland's avatar
Liam Morland committed
2

3
Built from [Drupal 8 core](https://drupal.org) and [Gesso](https://www.drupal.org/project/gesso) using the code from [Forum One](https://www.forumone.com/) and the [git hub repository](https://github.com/forumone/gesso).
Eric Bremner's avatar
Eric Bremner committed
4

5
## Requirements
6

7
8
9
10
11
  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/)
Chris Shantz's avatar
Chris Shantz committed
12
        - currently version 1.10.19
13

14
## Notes on theming
15
UW has taken the approach to use a component based design and has chosen [Forum 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).
16

Chris Shantz's avatar
Chris Shantz committed
17
Gesso is now installed with Composer as the [uw_wcms_gesso](https://git.uwaterloo.ca/wcms/uw_wcms_gesso) module in the composer.json.
18
19
20

## Using Pattern-Lab

Liam Morland's avatar
Liam Morland committed
21
22
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.
23
24
25
26

    EXAMPLE:
    https://d8alt/fdsu1/profiles/uw_base_profile/themes/uw_fdsu_theme_resp/uw_wcms_gesso/gesso/pattern-lab

Liam Morland's avatar
Liam Morland committed
27
28
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
29
30
31
32
33
34

    EXAMPLE:
    cd /var/www/drupal8/profiles/uw_fdsu_theme_resp/uw_wcms_gesso/gesso
    gulp

## Locally-modified modules
35
36
imageMagick 8.x-2.x-beta1-uw_wcms

37
38
- Base: 8.x-2.0-beta1
    - Patch 60b739: Fix Animated GIF resizing.
Liam Morland's avatar
Liam Morland committed
39
https://www.drupal.org/node/1802534#comment-12246133
40

41
42
components 8.x-2.0-beta1-uw_wcms1
- Base: 8.x-2.0-beta1
Liam Morland's avatar
Liam Morland committed
43
44
    - Patch 3761f753: Fix core requirements.
      https://www.drupal.org/project/components/issues/3100006#comment-13385658
45
46
47
48

eck 8.x-1.0-alpha5-uw_wcms1
- Base: 8.x-1.0-alpha5
    - 801e43d9: Patching updates after 8.7 drupal core
49

50
51
samlauth 8.x-3.0-alpha1-uw_wcms3
- Base: 8.x-3.0-alpha1
Liam Morland's avatar
Liam Morland committed
52
53
    - Patch 4a4b894d: fixing event subscribers.
      https://www.drupal.org/project/samlauth/issues/2925171#comment-12351528
54
55

## Testing
Liam Morland's avatar
Liam Morland committed
56
57
58
To prepare a Drupal install for testing with PHPUnit, copy
DRUPAL_ROOT/core/phpunit.xml.dist to DRUPAL_ROOT/core/phpunit.xml and in that
file set:
59

60
61
62
    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".
63

Liam Morland's avatar
Liam Morland committed
64
65
Tests can be run from the Drupal UI. To run tests from the command line, run
this in the DRUPAL_ROOT:
66

Liam Morland's avatar
Liam Morland committed
67
    sudo --user www-data vendor/bin/phpunit -c core
68

69
Where  is like: profiles/uw_base_profile/tests/src/Functional/UwWcmsBasicTest.php
70

Liam Morland's avatar
Liam Morland committed
71
72
Tests need to run with sudo because they need to run as the user that runs the
web server.