Overview
This product is a Craft CMS 4.x boilerplate developed by MadeByShape. It is designed to be used with the Tailwind CSS, VueJS, and Alpine.js frameworks. The project utilizes both Webpack and Gulp for building. It includes Craft CMS 4.x, Tailwind CSS 2.0.x, and the Javascript libraries Vue.js and Alpine.js. The product also includes various plugins, custom configurations, templates, blocks, components, and scripts. The roadmap for future development includes plans to use Webpack solely instead of a mixture of Webpack and Gulp, add Google Workbox, preload fonts via a Webpack task, and move some Twig components into VueJS. The product is developed by MadeByShape and maintained by Jason Mayo.
Features
- Craft CMS 4.x: The latest version of the Craft CMS content management system.
- Tailwind CSS 2.0.x: A utility-first CSS framework for building custom designs.
- Vue.js: A JavaScript framework for building user interfaces.
- Alpine.js: A lightweight JavaScript framework for building web interfaces.
- Templates: Pre-designed templates for common web pages.
- Blocks: Large chunks of markup or smaller components that can be easily added to templates.
- Components: Small bits of a template, such as buttons or input fields, that make up blocks or full templates.
- Plugins: Various plugins for enhancing the functionality of Craft CMS, including Asset Rev, Blitz, Freeform, Imager X, Minify, Retour, and SEOMatic.
Installation
To install the Craft CMS 4.x boilerplate, follow these steps:
- Make sure you have PHP 8.0+ and Composer 2.x.x installed on your system.
- Open your terminal and run the following command:
composer create-project madebyshape/craft-cms
- Do not run
./craft setup
. Instead, manually edit the.env
file with your desired configuration. - Once the
.env
file is filled in, run the following command to install Craft CMS:
./craft install
- To build the project, execute the following npm scripts:
- For local development:
npm run dev
- To generate production assets (minify, favicon, etc.):
npm run prod
- If the project already exists, use the following command to pull, migrate, apply project config, and run dev tasks:
npm run setup
Summary
The Craft CMS 4.x boilerplate by MadeByShape is a comprehensive toolkit for building web projects. It includes Craft CMS 4.x, Tailwind CSS, Vue.js, and Alpine.js, as well as a range of plugins and custom configurations. The boilerplate’s architecture includes both Webpack and Gulp for building the project. It provides pre-designed templates, blocks, and components to streamline the development process. The roadmap for future development shows a commitment to continuous improvement and adding new features. Overall, this boilerplate offers a solid foundation for creating dynamic and engaging websites.