ademers/craft-starter

Craft CMS 3.7.x Starter Project

A Craft CMS starter project by Andrea DeMers.

Content Management System (CMS)

• Craft CMS 3.7.x Solo Edition
• Craft CMS 3.7.x documentation

Craft CMS Plugins

• Contact Form
  • fromName field set to required via a custom Site Module
• Minify
• Redactor
• SEOmatic
• Sprig
• Vite

PHP Packages

• Craft Scripts

Front-end

Build Tools

• Vite

CSS

• Tailwind CSS
• Tailwind CSS Aspec Ratio plugin
• Tailwind CSS Forms Plugin
• Tailwind CSS Typography Plugin
• Tailwind UI (commercial license required)

JavaScript

• Alpine JS
• lazySizes

Requirements

• Craft CMS server requirements
• Craft CMS control panel browser requirements
• Composer PHP dependency manager 1.3.0 or later

Local Dev

This Craft Starter project is configured to use Craft Nitro 2.x as the local development environment.

• Craft Nitro 2.x
  • PHP 8.0.16 for future compatibility with Craft 4. See Upgrading from Craft 3 docs
  • MySQL 5.7.33. (May change to 8.x in near future)
• Craft Nitro 2.x Mailhog for email
• Craft Nitro 2.x Redis for caching

Installation

• To create a new project, run composer create-project ademers/craft-starter <Path>, substituting <Path> with the path where Composer should create the project
• Create a database as per the instructions in the Craft documentation
• Set up your web server as per the instructions in the Craft documentation
• Duplicate the .env.example file in the project root and rename it to .env
• Run the Craft setup wizard ./craft setup and answer the questions when prompted
• Access your new Craft website from your web browser
• Do a little dance :dancer:

Todo

• Prep for Craft 4.
• Get Vite critical CSS working with Craft Nitro
• Get Vite Favicon generation working with Craft Nitro
• Add a Craft custom site module as per Enhancing a Craft CMS 3 Website with a Custom Module article
• Update installation instructions to include Nitro & Packagist versions
• Replace Vue.js with Alpine.js as default JavaScript framework
• Add installation instructions

License

The MIT License (MIT). Please see License file for more information