README.md

Miranj Craft Boilerplate

A Craft CMS 5 starter project based on Miranj’s project boilerplate (see craft4 or craft3 for the older versions).

Contents

• Features
• Usage
• Changelog
• License

Features

This starter project includes:

• Our modular templating architecture.
• Our multi-tiered caching architecture with full-page template caches in Craft, and FastCGI micro-caching in Nginx).
• A Gulp based build process that uses
  • Alpine.js
  • Instant.page
  • LazySizes
  • PhotoSwipe
  • Tailwind CSS
• Server configuration files for Apache (dev) and Nginx (staging, production).
• A few Craft plugins, along with their config files:
  • Child Me
  • CKEditor
  • CP Field Inspect
  • Element Index Defaults
  • Environment Label
  • Field Manager
  • Imager
  • Image Resizer
  • Minify
  • No-Cache
  • Obfuscator
  • Retcon
  • SEOMate
  • Twig Perversion
  • Typogrify
• Prettier for auto-formatting (all non-Twig) code.
• Ready to import fields to speed up the project development process.

Usage

1. Open your terminal and run the following command:

   composer create-project miranj/craft-boilerplate:dev-dev /path/to/project
   

2. Replace instances of miranj/craft-boilerplate and boilerplate with the handle of the new project in the following locations:

   • composer.json
   • package.json
   • .ddev/config.yaml
   • config/app.php
   • src/Module.php
   • serverconfigs/envs/production/env.conf
   • serverconfigs/envs/production/setup.conf
   • serverconfigs/envs/staging/env.conf
   • serverconfigs/envs/staging/setup.conf

3. Replace instances of "Miranj Craft Boilerplate" / and "Boilerplate" with the title of the new project.

4. Inspect all FIXME comments in the project and take necessary action.

5. Assign values to all shared environment variables in .env.example.