terryupton/boilerplate-craft

A starting boilerplate for Craft Projects

4.1.1 2021-05-05 14:58 UTC

Requires

• craftcms/cms: ^3.6
• craftcms/redactor: ^2.8.2
• mmikkel/retcon: ^2.2
• nystudio107/craft-imageoptimize: ^1.6
• nystudio107/craft-minify: ^1.2
• nystudio107/craft-seomatic: ^3.3
• nystudio107/craft-twigpack: ^1.2
• verbb/field-manager: ^2.2.1
• verbb/image-resizer: ^2.1
• vlucas/phpdotenv: ^2.6
• yiisoft/yii2-redis: ^2.0

MIT

README

A starting boilerplate for Craft 3 projects using Laravel Mix, Tailwind CSS

Installation

1. To create a new project, run composer create-project terryupton/boilerplate-craft <Path>, substituting with the path where Composer should create the project.

2. Update a .env file adding the database connections and other settings

3. Run ./craft setup and follow the instructions

4. Refer to new READdME.md file for further instructions

Content Management System (CMS)

• Craft CMS
• Craft CMS 3.x documentation

Front-end

Build Tools

• Laravel Mix

CSS

• Tailwind CSS
• Tailwind UI

JavaScript

• Alpine JS
• lazySizes
• Vue.js

TODO:

• Create proper Readme file and instructions. https://github.com/miranj/craft-boilerplate https://github.com/ademers/craft-starter https://github.com/madebyshape/craft-3 https://github.com/timkelty/craftcms-boilerplate https://github.com/nystudio107/craft

• Add default files for composer, package, readme - see this example https://github.com/miranj/craft-boilerplate

• Add Vue and Apline to package.default once created.

• Create better boilerplate template architecture.
  https://nystudio107.com/blog/an-effective-twig-base-templating-setup

• Update proejct.yaml to add 1.0.0 schema versions for plugins.

• Update proejct.yaml to fix terms block and redactor field.

• Setup Humans.txt defaults in SeoMatic php settings files. https://nystudio107.com/blog/tips-for-using-seomatic-effectively

• Add fallback <title> tag into head.twig if SEOmatic fails.

• Add fallback meta tags into head.twig if SEOmatic fails.

• Convert Classes in components to arrays

• Convert Email QueryString to an Array (subject and body)

• Set button.twig component to switch between button and a href

• Set and test button.twig to use classes as an array and then apply this approach to other components.

License

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