How judicialcouncilofcalifornia/jcc-srl works
This project is a full‐stack Drupal 8 application that serves as a CMS-based website with a rich backend comprising numerous custom and contributed modules along with a custom Drupal theme (based on JCCBase/atrium). The system is built with modern development practices including Composer-based dependency management, configuration management via config splits and exclusions, automated testing (PHP unit, code sniffer, and Cypress tests), and a CI/CD pipeline (CircleCI) that deploys to Pantheon multidev environments. There are also local development conveniences via Lando (Docker) making it possible to run the full stack locally.
• Developer Environment:
– Local development with Lando (see lando.yml, docker-related settings, examples directory for sample settings)
– Local database import and environment reset procedures (see “Local Development” section in the README)
• Source Code and Dependency Management:
– GitHub repository and Git workflow branches (feature branches, develop, stage, master)
– Composer-based dependency and patch management (composer.json, composer.lock, patches folder)
• Continuous Integration / Continuous Deployment:
– CircleCI integration (.circleci directory with deploy and testing scripts)
– Automated testing (PHP linting, Code Sniffer hooks, Cypress integration with tests in test/cypress)
• CMS Backend:
– Drupal 8 core and its configuration management system (see extensive config/ folder with YAML files for core configuration, modules, views, fields, etc.)
– Custom modules (located in web/modules/custom such as cc, jcc_admin, jcc_autocomplete_helper, jcc_boilerplate, jcc_datefinder, jcc_forms, and others)
– Contrib modules managed via Composer along with patches applied in patches folder
• Theming / Frontend:
– Custom theme (web/themes/custom/atrium) which is a subtheme of JCCBase
– Template files, assets (JS, CSS, images), and configuration for the theme
• Hosting & Environments:
– Pantheon hosting integration – multidev environments mapped to branches (master for production, stage and develop for intermediate environments)
– Deployment process triggered by GitHub pushes merging into appropriate environment branches
• “Source Code Repository” (GitHub) as a central hub with branch labels. Indicate that feature branches merge into develop/stage/master.
– CMS Core and Configuration (config folder and structure for sites, config splits, etc.)
– Custom Modules (list a few key custom modules like cc, jcc_admin, jcc_forms, etc.)
– Theme (atrium subtheme under web/themes/custom/atrium)
• Optionally, add external integrations if relevant (for example, external services triggered by Drupal modules such as analytics or REST endpoints).
Architectural Patterns and Design Principles
• Separation of Concerns: Note how frontend theming (presentation layer) is separated from the backend CMS logic (custom modules and configuration management).
• Environment Isolation: Emphasize the segregation between local, development (multidev), staging, and production environments.
• Configuration as Code: Capture how configuration management (via YAML files, config splits, and Composer) ensures that all environment‐specific settings are maintained in code.
• Automated Testing & Deployment: Indicate that the CI/CD pipeline automates testing (unit tests, E2E testing via Cypress) and deployment steps (running drush commands like updb, cim, and clearing caches).
Tools, Technologies, and Key Files
• Use of Composer (composer.json, composer.lock), Lando (.lando.yml), and Pantheon configuration (pantheon.yml)
• Mention that the CI configuration is housed under the .circleci directory and that automated testing scripts (in test/cypress) drive end-to-end testing.
• That customizations reside within web/modules/custom and web/themes/custom, giving a clear separation between Drupal core, contributed extensions, and project-specific customizations.