ademers/craft-starter

A Craft CMS starter project by Andrea DeMers.

1.4.4 2022-05-23 19:56 UTC

Requires

• craftcms/cms: 3.7.43
• craftcms/contact-form: 2.5.1
• craftcms/redactor: 2.10.8
• nystudio107/craft-minify: 1.2.11
• nystudio107/craft-scripts: 1.2.10
• nystudio107/craft-seomatic: 3.4.30
• nystudio107/craft-vite: 1.0.25
• putyourlightson/craft-sprig: 1.13.0
• vlucas/phpdotenv: ^3.4.0
• yiisoft/yii2-redis: ^2.0

MIT

• cms
• project
• Craft
• craftcms

README

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

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

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