frmwrk/drupal-project

Project template for Drupal 8 projects with composer

Installs: 6

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 0

Forks: 778

Type:project

8.x-dev 2020-01-15 14:41 UTC

This package is auto-updated.

Last update: 2020-01-15 14:45:36 UTC


README

Laatst bijgewerkt 10-12-2019 door Jelle.

Voor installatie zie onderste gedeelte van deze Readme

Over [project] is de Corporate website van [project].

README [project]; development | Frontend

Afspraken bij ontwikkeling

  1. Code wordt in engelse taal geschreven incl comments en t() functies.
  2. Labels/page-paden mogen in het nederlands (Deze zijn later altijd evt. aan te passen)
  3. Gebruik van view modes / form modes ipv velden in views (Met uitzondering van tabellen en simpele lijsten)
  4. Let op naamgeving machine-names. Deze worden automatisch gegenereerd maar zijn daardoor soms nietszegggen. Controleer deze op format en leesbaarheid (Engelse taal heeft voorkeur)
  5. Drupal coding standarts Coding standards Drupal.org
  6. Drupal 8 (Laatste stabiele versie)
  7. Composer require/update voor contrib module installatie & updates / composer install als je project binnentrekt
  8. Templates staan in /docs/templates/

Testen

Er zijn nog geen tests geschreven voor dit project. Wel wordt Grumphp vereist bij development op [project].

Zie installeren voor informatie over het gebruik hiervan.

Omgevingen

Waar is het gehost?

Over [project] wordt gehost bij Combell en Now (Frontend). Zie servers.yml voor details.

Installeren

  1. Je kunt zelf je dev stack gebuiken. voor DDEV zie de algemene uitleg

    1. Verander de projectnaam in .ddev/config.yml
  2. Installeer de dependencies

    composer install
    
  3. Installeer grumphp voor code quality checks

    vendor/bin/grumphp git:init
  4. Kopieer /web/sites/default/template.settings.local.php naar default/settings.local.php ;

  5. Voor de frontend volg de Frontend in /frontend

Werken aan feature

  1. Checkout feature branch op basis van master.

  2. Update configuratie en packages

    composer install
    drush updb
    drush cim
    drush locale-check && drush locale-update
  3. Als je lang aan een feature branch werkt. rabase dan op master

  4. Check je code met

    vendor/bin/grumphp run

Releasen

Releases gaan via CI.

Custom modules in this project

Custom modules staan in /modules/custom

  • [project]_decoupled - Graphql extensies voor [project]. Gebaseerd op de frmwrk_decoupled module

Documentation

  • Nog geen externe documentatie

Drupal-structuur

Functionaliteit / Modules

  • Bijzonderheden hier

Back-end Ontwikkelflow Drupal

  1. Basis-configuratie Drupal
    • Search index
    • Content-types
    • Pages
    • url-alias patterns
    • Site-instellingen
  2. permissions
  3. Security-checks
  4. redirects
  5. Optimalisatie performace
  6. Inregelen live - caching / Cron

Composer template for FRMWRK Drupal projects

This project template provides a starter kit for managing your site dependencies with Composer.

If you want to know how to use it as replacement for Drush Make visit the Documentation on drupal.org.

Usage

  1. First you need to install composer.
  2. Install ddev for local dev server

After that you can setup the project:

  1. Create new base composer create-project frmwrk/drupal-project:base-dev [some-dir] --no-interaction

  2. Spin up you development container DDEV (See DDEV manual)

    1. Change project name in .ddev/config.yml
    2. Copy sites/default/template.settings.local.php to settings.local.php
    3. (optional) When running mac create a file named .ddev/config.local.yaml with contents
      nfs_mount_enabled: true
    4. Use ddev start
  3. run ddev drush si --existing-config

    1. (optional) Instead of the site installer you can import using ddev import-db [db-dump-file]
  4. Commit the initial files.

  5. With composer require ... you can download new dependencies to your installation.

  6. Do your thing as usual. Commit and create branches

  7. For xdebug use ddev x (enable) and ddev x 0 (disable) and don't forget to do this every time ddev start runs. Also turn off browser profiler for much better performance.

  8. After checking out use ddev update for automatically composer install + updb + cim + locale-check + locale-update

  9. Create your own usefull commands in .ddev/commands (See examples there)

Tip: Create your own locale bash aliases to make commands like ddev drush even shorter

  • For example: alias ddr='ddev drush'

Updating Drupal Core

Follow the steps below to update your core files.

  1. Run composer update drupal/core webflo/drupal-core-require-dev "symfony/*" --with-dependencies to update Drupal Core and its dependencies.