Skip to content

Latest commit

 

History

History
197 lines (137 loc) · 10.2 KB

README.md

File metadata and controls

197 lines (137 loc) · 10.2 KB
Raw

Boilerplate Website

This repository is for the Boilerplate website at boilerplate.com.

Site Notes

Add notes here that describe any weird functionality, such as commerce intergrations, external services, or custom tools.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

  • The site is built with Craft CMS
  • For general configuration settings, see config/general.php
  • See the Craft docs for available config settings

Prerequisites

Craft CMS is built on PHP, so it needs a local environment to run it. See Craft's basic requirements here. This project should run in various dev environments, but it assumes DDEV by default. To run this site locally, you will need:

  • Composer 2.0+
  • DDEV (or Apache/Nginx)
  • PHP 8.2+
  • MySQL 8.0.17+ using InnoDB
  • 512MB+ of memory allocated to PHP

If you're using Apache instead of nginx, you'll need to download Craft's default .htaccess file and put it in the document root. See https://craftcms.com/docs/5.x/requirements.html#required-php-extensions for required PHP extensions.

DDEV Hooks

If you're using DDEV, note the post-start hooks in config.yaml:

hooks:
   post-start:
      - exec: npm install
      - exec: npm run build
      - exec: composer install

These will:

  • Install npm packages so the build process can run
  • Build the project and copy static assets from src/public to web/dist
  • Install Craft + plugins, then run migrations (see "Composer Scripts" below for explanation)

These will run every time the container starts to make sure you have the same packages installed as any other developer working on the site.

Project Config

This Craft website uses Project Config. This has a few implications when there are multiple developers working on the same project.

  • Whenever you start work on a project, check for changes in the remote branch. If there are any, pull these down and run composer install. This will also run the scripts at the bottom of composer.json, which will run Project Config migrations on your local database.
  • If there are Project Config merge conflicts, it normally just means the dateModifed in project.yaml has changed, but please check you're not deleting files another developer has set up.
  • Never overwrite the staging or production database with a local copy.
  • All database structure changes are made locally. Those changes are stored in Project Config, and applied to the staging and production databases on deployment. No database structure changes are permitted on staging or production sites.

Installation

Creating a new site from this Boilerplate

  • Create a new repository using this one as a template

  • Clone the site

  • edit .ddev/config.yaml and change the name key to something unique to this site

  • Run ddev start

  • In .env update:

    • CRAFT_ENVIRONMENT to dev
    • SYSTEM_STATUS to on
    • SYSTEM_NAME to the title of this project
    • Run ddev craft setup/app-id
    • Run ddev craft setup/security-key
    • Update the other variables under # General settings

  • Run ddev npm update to install the latest packages from package.json

  • Run ddev composer install to install Craft and it's plugins from composer.json

  • Run ddev craft setup

  • Run ddev craft project-config/rebuild

  • Update the details in package.json

  • Update the site details in this README.md file

  • Go to Settings > Plugins and deleted the license keys as they can be tied to other domains

  • Refresh the page, then add the newly generated license keys to .env

  • Replace the keys in the control panel with the PLUGIN_NAME variables from .env

Installing a local copy of this site

  • Clone this repository

  • Run ddev start

  • In .env update:

    • CRAFT_ENVIRONMENT to dev
    • SYSTEM_STATUS to on
    • SYSTEM_NAME to the title of this project
    • Copy the CRAFT_SECURITY_KEY from the live site
    • Update the other variables under # General settings
    • Copy the plugin license keys from the live site

  • Run ddev npm install to install the packages from package.lock

  • Run ddev composer install to install Craft and it's plugins from composer.lock

  • Run ddev craft setup/app-id

  • Download a database backup from the Utilities section of the live site, copy the .sql file into the project root, then run ddev import-db

  • Delete the sql file

  • Copy config/license.key from the server as this isn't stored in the repository

  • You can download user-uploaded assets from the server either through SFTP, SSH, or with one of the rsync commands below:

Syncing assets

  • Staging to local: rsync -rtP --delete [email protected]:/home/ploi/staging.boilerplate.com/web/uploads/ web/uploads/
  • Production to local: rsync -rtP --delete [email protected]:/home/ploi/boilerplate.com/web/uploads/ web/uploads/

Code Formatting

  • This project uses Prettier for automatic code formatting, with the Prettier for Melody plugin to make it work with Twig files. This is an opinionated way to format code which keeps spacing consistent between developers
  • The configuration for Prettier in this project is defined in .prettierrc.json
  • To ignore certain files or paths, add them to .prettierignore
  • It's easiest to set up Prettier to format files automatically on save (you can do this with Visual Studio Code). To do this, follow Prettier with Twig in VS Code.

Code formatting with Prettier & Tailwind class sorting

Visual Studio Code can be set up to format twig files on save using Prettier. The following repositories in package.json are used for this:

"@prettier/plugin-php": "^0.22.2", // formats PHP files
"@zackad/prettier-plugin-twig-melody": "^0.6.0", // Fixes Trivago's repository to format twig files
"prettier": "^3.2.5", // The formatting engine
"prettier-plugin-tailwindcss": "^0.5.13", // Tailwind's plugin to sort Tailwind classes
"tailwindcss": "^3.2.3", // Tailwind itself

These files configure how it works:

  • .prettierrc.json - defines how files should be formatted
  • .prettierignore - tells Prettier which files to ignore

See these two articles for details on how to setup VS Code to auto-format twig files on save:

Build notes

  • In package.json, the engines key is set to use node 18 or above, because prettier-plugin-twig-melody requires higher than version 18. This is installed by DDEV's config.yaml, which is set to nodejs_version: "18". By defualt, DDEV would otherwise install node 16.
  • The engine-strict=true in .npmrc enforces this requirement so that any developer working on this project must use at least node 18
  • DDEV comes with nvm pre-installed, so you can also use that to switch versions within a container
  • In package.json, the "type": "module", line is required by Vite 5. This makes all js files in the project root behave like ES modules, and they need updating accordingly.

Front End CSS (Tailwind)

  • This project uses Tailwind CSS
  • Tailwind can be configured with the tailwind.config.js file in the project root
  • Tailwind uses PostCSS. This can be configured with the postcss.config.js file in the project root

Front End Build Process (Vite)

Front end resources are compiled with Laravel Vite using nystudio107's Vite plugin.

  • NPM scripts are in the package.json file in the root
  • To start the dev server, run npm run serve. This will give you a list of IP addresses. Ignore them, and access the site as usual on your normal dev domain (depending on whether you're using DDEV or Valet). When you save Twig files, the page will refresh. When you save CSS or JS files, the page will reload those resources via Hot Module Replacement
  • To build front end assets for the production server, run npm run build
  • Vite can be configured in vite.config.js in the root of the repository

Composer Scripts

Below is an explanation of what all the scripts are for in composer.json. These mostly relate to the deployment process.

  • craft-update Runs Craft migrations (see post-update-cmd and post-install-cmd), applies Project Config & clears caches
  • deploy-staging When deploying to the staging site via Ploi, this runs composer install, then migrations
  • deploy-production When deploying to the production site via Ploi, we only need to run migrations because Ploi rsyncs all files and the Composer packages from staging
  • post-update-cmd After composer update, run migrations
  • post-install-cmd After composer install, run migrations
  • nuke Removes all Composer packages & the lock file, then runs composer update again with a clear cache

Reference: Composer Commands.

Server & Hosting

  • The site is hosted on UpCloud under the client's own account
  • The server is provisioned with Ploi which handles deployment, security updates, databases & SSL

Deployment

  • The staging site is deployed automatically when you push to the main branch. Ploi will run composer deploy-staging
  • The production site is deployed manually by logging into Ploi > Servers > server-name > sitename.com > "Deploy to production". Ploi will run composer deploy-production

Built With

Versioning

We use Git for versioning.

Authors