Skip to content
Snippets Groups Projects

Update CONTRIBUTING.md to include missing step

Merged Update CONTRIBUTING.md to include missing step
issue/experience_builder-3499650:3499650-contributing.md-is-nearly into 0.x
Merged Luke Leber requested to merge issue/experience_builder-3499650:3499650-contributing.md-is-nearly into 0.x
Compare
and
1 file
+ 9
− 8
Compare changes
  • Side-by-side
  • Inline
CONTRIBUTING.md
+ 9
− 8
# See it in action + recommended development environment
1. Drupal 11 (preferably a clone for Git archeology: `git clone https://git.drupalcode.org/project/drupal.git` — 10.3 will work too).
2. `composer require drush/drush`
3. `drush si standard`
4. `drush pm:install experience_builder xb_dev_standard`
5. Build the front end: `cd modules/contrib/experience_builder/ui` and then either
2. Add `$settings['extension_discovery_scan_tests'] = TRUE;` to the end of the `sites/default/settings.php` file (this allows the `xb_dev_standard` hidden module to be installed).
3. `composer require drush/drush`
4. `drush si standard`
5. `drush pm:install experience_builder xb_dev_standard`
6. Build the front end: `cd modules/contrib/experience_builder/ui` and then either
* With Node.js available: `npm install && npm run build`
* With Docker available: `docker build --output dist .`
6. Browse to `/node/add/article` just enter a title for the article and hit save. This will create a node with an empty canvas for the field `field_xb_demo`.
7. In the toolbar, click "Experience Builder"! 🥳
8. If you're curious: look at the code, step through it with a debugger, and join us!
9. If you want to run *all* tests locally, including the OpenAPI spec one: `composer require league/openapi-psr7-validator webflo/drupal-finder devizzent/cebe-php-openapi --dev`
7. Browse to `/node/add/article` just enter a title for the article and hit save. This will create a node with an empty canvas for the field `field_xb_demo`.
8. In the toolbar, click "Experience Builder"! 🥳
9. If you're curious: look at the code, step through it with a debugger, and join us!
10. If you want to run *all* tests locally, including the OpenAPI spec one: `composer require league/openapi-psr7-validator webflo/drupal-finder devizzent/cebe-php-openapi --dev`
# During development
The following commands assume the recommended development details outlined above, particularly the location of the `vendor` directory. If your `vendor` directory is not adjacent to your `index.php` — if you created your environment using [`drupal/recommended-project`](https://packagist.org/packages/drupal/recommended-project), for example — you will need to adjust the command path (i.e., `../vendor` instead of `vendor`). If you are using our DDEV add-on ([`TravisCarden/ddev-drupal-xb-dev`](https://github.com/TravisCarden/ddev-drupal-xb-dev)), convenience commands are provided.