Motivation

The Starterkit is a really good base to set up a project fast and there are some improvements which would make nifty and helpful additions such as

  • Improving the structure of the README.md file
  • Adding some scripts along with the necessary DDEV commands and Lando toolings to automate tedious, repetitive tasks

Proposed resolution

Improvements to README.md

The README.md file has been slighty restructured for better readability and the following sections have been added:

  • Installation Requirements
  • Regular DDEV commands
  • Script: A table with scripts which can be invoked by a DDEV command or Lando tooling
  • Routing and Nginx Configuration

Addition of new scripts

Some nifty scripts from a different customer project have been added which helped automate tedious tasks such as

  • Regenerating the Nginx configurations wich just one command/tooling.
  • Check and update locales (translations) locally or on the server.
  • Re-indexing Search API indices right from the CLI.
  • Composer Update Info: A small command to display which Composer package can be updated and if it patched.
Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

Comments

martinpe created an issue. See original summary.

martinpe’s picture

Assigned: Unassigned » pfrenssen
Status: Active » Needs review

Ready for review.

pfrenssen’s picture

I really like the improvements to the README but I would not add the additional scripts. The scripts are super cool but they don't really fit in the scope of a starterkit. They would fit better in a BLT-like project intended for mature websites which are already in production. Also I think most developers will have their own collection of scripts tailored to their own preferences.

pfrenssen’s picture

The DDEV command to regenerate the Nginx config is very useful! Thanks for adding that!

martinpe’s picture

Assigned: pfrenssen » dulnan
ayalon’s picture

I have merged and included all the improvements. Thanks for the valuable feedback and the effort to improve the starterkit.

ayalon’s picture

Status: Needs review » Fixed
ayalon’s picture

Status: Fixed » Closed (fixed)