architchandra / craft-boilerplate

A Craft CMS 3 start project by Miranj

Miranj Craft Boilerplate

A Craft CMS 3 starter project based on Miranj's project boilerplate. It includes:

• Our modular templating architecture.
• A Gulp based build process that uses
  • Tailwind CSS.
  • Font Face Observer
  • fontloader
  • lazySizes
  • Pjax
• Server configuration files for Apache (dev) and Nginx (staging, production).
• A few Craft plugins, along with their config files:
  • Agnostic Fetch
  • CacheFlag
  • Child Me
  • CP Field Inspect
  • Element Index Defaults
  • Environment Label
  • Imager
  • Inventory
  • Minify
  • Redactor
  • SEOMate
  • Twig Perversion
  • Typogrify

Usage

1. Open your terminal and run the following command:

   composer create-project miranj/craft-boilerplate /path/to/project "dev-master"
   

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

   • composer.json
   • assets/package.json
   • 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.

6. Run composer dump-autoload