systemseed/drupal_reactjs_boilerplate

Docker based Drupal / React boilerplate with Unit / API / End-to-end test coverage examples.

What is this project for?

The main purpose of the project is to provide a super-quick start for fully decoupled applications development based on Drupal 8 and React.

Our main goal was to create the boilerplate with minimal amount of opinionated set of features, but at the same time give developers a solid base for start to let them focus on the development and do not worry about infrastructure / integrations set up.

What does this project include?

We've got many little developers tricks and sugar added, but from the very high level the project includes:

• One-command installation experience for the whole development / testing infrastructure
• Docker configuration to avoid any necessity in third-party tools installed on your local machine
• Configured Drupal 8 application based on Contenta CMS for comprehensive decoupled development
• Configured React.js application based on Next.js for Server Side Rendering support and great dev experience
• 3 types of tests included (Unit / Integration, API, Acceptance) with examples, Drupal API integration & database connection
• Platform.sh ready configuration for those who want to run the project in web
• Simple commands for automated code quality checks / fixes
• Continuous Integration example for CircleCI to test project installation, code quality & run tests.

Installation

1. To get everything installed locally, simply use the following commands:

   cd drupal_reactjs_boilerplate
   make install
   

2. That's it, the Decoupled application is ready for development!

Access the applications

• http://app.docker.localhost - React.js application
• http://drupal.docker.localhost - Drupal 8 backend. Login credentials are admin / admin.

Demo content

This boilerplate comes as an example of integration between frontend and backend applications, therefore all demo content is enabled by default. However, if you want to get rid of it and focus on development - all you need to do is to delete the module with demo content by calling make drush pmu recipes_magazin.

Explore the documentation

• Shorthand commands
• Features
• Writing automated tests

drupal_reactjs_boilerplate's Issues

Replace custom git push command with platform environment:push

Uninstall unused modules

We need to uninstall currently unused modules.

Move libraries from web/libraries to composer.json

Install an additional useful modules

Would be nice to have some useful modules installed by default, like Admin menu, Module filter etc.

Windows OS installation

Hi. I rewrote some files for make command can work on windows, but on step installing contenta_jsonapi I get the error "Call to a member function setFormClass() on null in system_entity_type_build()".
Maybe you can help for fix this error or write full instruction how user can start you project on windows os.
Thank you!

Dirty git status after `make install`

After executing make install:

Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git checkout -- <file>..." to discard changes in working directory)

	modified:   drupal/web/sites/default/settings.php

Untracked files:
  (use "git add <file>..." to include in what will be committed)

	drupal/keys/

Clean up .gitignore files across all folders

Fix broken http protection

After moving out of Drupal to standalone domain, http authentication does not work anymore.

Add environment switch operation

• Enable / disable dev modules
• Enable / disable test users

Replace custom backup scripts with CI job

Add example of automated tests coverage for emails

Remove PLATFORMSH_CLI_TOKEN if it's not needed

Add CI job which updates boilerplate modules / packages to the latest versions automatically

The idea behind this is to automatically run composer / yarn updates on a weekly basis, run all tests & merge changes to master if tests have passed.

Allow config management from UI on production environment

Problem

Drupal stores most of the configuration in files but still allows to edit it using admin UI. Currently, drupal_reactjs_boilerplate suggests reverting all configs on deployment which means that all changes made by admins on production site will be lost. In some cases it may become an issue:

1. Admin changed site email address and ensured that it works.
2. A few days after that deployment took place. The email was reverted back to the original (old) value.
3. Neither developers nor admins are aware that it happened.

Rename PLATFORMSH_PROJECT_NAME into PLATFORMSH_PROJECT_ID

Add project-level test coverage

• PHP Unit tests
• PHP API tests
• Acceptance tests

Add Make command to support composer inside of php container

Variables missing from .env.default

I tried out this boilerplate and it is awesome, I am wanting something that makes use of GraphQL for querying data, and only use rest for posts etc. This is a great starting point for me.

The ONLY issue I had is that the variables FRONTEND_HOST are not declared in the .env.default file:

FRONTEND_HOST=fe.docker.localhost
BACKEND_HOST=be.docker.localhost

Thanks

CORS issue when requesting data

TO REPLICATE

Install and run boilerplate as per instructions. Navigate via "Home" or "Go to Homepage" buttons.

EXPECTED

Page is displayed with same data as initial load/browser refresh.

ACTUAL

CORS error that results in displaying a 500 along with error message.

Install another admin theme for contenta

Add default .platform/config.yaml file for CI

Introduce make command to install project from database backup

Trying to understand

So this is a drupal 8 site, but not a normal one. It is a react web app. correct?

How can I convert my existing drupal site or a distribution to a react app?

Install fails on macOS

-p drupal_reactjs_boilerplate: Installing dependencies for React.js application...
services.php must be a mapping
make[1]: *** [prepare:frontend] Error 15
make: *** [install] Error 2