You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
-
# DDEV Drupal Experience Builder Development Environment
1
+
# DDEV Drupal Canvas Development Environment
2
2
3
-
This creates and configures a DDEV project for local Drupal [Experience Builder](https://www.drupal.org/project/experience_builder) (XB) module development. Specifically, it creates a Drupal site, clones and installs the module, sets up the front-end dependencies, and provides specialized development and testing tools.
3
+
This creates and configures a DDEV project for local [Drupal Canvas](https://www.drupal.org/project/canvas) module development. Specifically, it creates a Drupal site, clones and installs the module, sets up the front-end dependencies, and provides specialized development and testing tools.
4
4
5
5
> **Notice:** This add-on is experimental. See [Support & community](#support--community) below.
6
6
@@ -54,9 +54,9 @@ ddev xb-workspaces-dev
54
54
55
55
The resulting DDEV project is just like any other one. Interact with it using the [the built-in commands](https://ddev.readthedocs.io/en/stable/users/usage/commands/), e.g., `ddev launch` to browse the site.
56
56
57
-
The installation process clones [the Experience Builder module](https://www.drupal.org/project/experience_builder) into `web/modules/contrib/experience_builder`. Develop and contribute from either location like you would any other Git repo for a normal Drupal project.
57
+
The installation process clones [the Drupal Canvas module](https://www.drupal.org/project/canvas) into `web/modules/contrib/canvas`. Develop and contribute from either location like you would any other Git repo for a normal Drupal project.
58
58
59
-
Any time you update the Experience Builder module or modify its front-end code, be sure to rebuild the UI app assets:
59
+
Any time you update the Drupal Canvas module or modify its front-end code, be sure to rebuild the UI app assets:
60
60
61
61
```shell
62
62
ddev xb-ui-build
@@ -68,25 +68,25 @@ When developing the React app, make sure to use the HTTPS URL of your DDEV proje
68
68
ddev xb-ui-dev
69
69
```
70
70
71
-
To completely reinstall Drupal and the Experience Builder module, run:
71
+
To completely reinstall Drupal and the Drupal Canvas module, run:
72
72
73
73
```shell
74
74
ddev xb-site-install
75
75
```
76
76
77
-
For the full list of available Experience Builder commands, run this:
77
+
For the full list of available Drupal Canvas commands, run this:
78
78
79
79
```shell
80
80
ddev | grep xb-
81
81
```
82
82
83
83
## Updating
84
84
85
-
Update the Experience Builder module clone just like you would any other Git repo. No tools are currently provided for updating Core.
85
+
Update the Drupal Canvas module clone just like you would any other Git repo. No tools are currently provided for updating Core.
86
86
87
87
## Cypress
88
88
89
-
Experience Builder uses [Cypress](https://www.cypress.io/) for front-end testing. It is currently only supported on macOS.
89
+
Drupal Canvas uses [Cypress](https://www.cypress.io/) for front-end testing. It is currently only supported on macOS.
- Background on this add-on: [DDEV support for Cypress tests [#3458369] | Drupal.org](https://www.drupal.org/project/experience_builder/issues/3458369)
135
+
- Background on this add-on: [DDEV support for Cypress tests [#3458369] | Drupal.org](https://www.drupal.org/project/canvas/issues/3458369)
Copy file name to clipboardExpand all lines: commands/host/xb-setup
+13-13Lines changed: 13 additions & 13 deletions
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
#!/bin/bash
2
2
3
3
## #ddev-generated
4
-
## Description: Set up the Experience Builder development environment.
4
+
## Description: Set up the Canvas development environment.
5
5
## Usage: xb-setup
6
6
## Example: ddev xb-setup\nddev xb-setup --force
7
7
## Flags: [{"Name":"force","Shorthand":"f","Usage":"Completely reset an existing environment if present and start over"}]
@@ -28,26 +28,26 @@ while :; do
28
28
done
29
29
30
30
# Exit early if the environment is already set up.
31
-
if [ -d web/modules/contrib/experience_builder/.git ] && [ !"$FORCE" ];then
31
+
if [ -d web/modules/contrib/canvas/.git ] && [ !"$FORCE" ];then
32
32
GREEN="\033[0;32m"
33
33
NO_COLOR="\033[0m"
34
-
printf"%bThe Experience Builder development environment is already set up.%b\n""$GREEN""$NO_COLOR"
34
+
printf"%bThe Drupal Canvas development environment is already set up.%b\n""$GREEN""$NO_COLOR"
35
35
# shellcheck disable=SC2016
36
36
echo'Note: If the environment is broken, run `ddev xb-setup --force` to completely reset it and start over.'
37
-
echo'Warning: If you do this, you will lose any changes you have made to the Experience Builder module or your Drupal site. Back up anything you want to save.'
37
+
echo'Warning: If you do this, you will lose any changes you have made to the Drupal Canvas module or your Drupal site. Back up anything you want to save.'
38
38
echo Hint: ddev xb-setup --force
39
39
exit
40
40
fi
41
41
42
-
# Remove the Experience Builder module if it's there.
43
-
rm -rf web/modules/contrib/experience_builder
42
+
# Remove the Drupal Canvas module if it's there.
43
+
rm -rf web/modules/contrib/canvas
44
44
mkdir -p web/modules/contrib
45
45
46
-
# Place the Experience Builder module via Git for development. Require
46
+
# Place the Drupal Canvas module via Git for development. Require
47
47
# it with Composer to test its composer.json and place dependencies.
# @todo: Suppress "WARNING: You are currently running a version of TypeScript which is not officially supported by @typescript-eslint/typescript-estree."
0 commit comments