ackstudio/craft

CraftCMS boilerplate

1.1 2025-03-25 10:25 UTC

This package is auto-updated.

Last update: 2025-04-25 12:14:10 UTC


README

Welcome to the Craft CMS 5 Boilerplate by ACK STUDIO. This starter kit is specifically crafted for in-house use at ACK STUDIO, providing a solid, opinionated foundation for launching any new Craft CMS project.

Tech Stack

  • Craft CMS 5.x - Powerful Content Management System
  • DDEV - Docker-powered Local Development Environment
  • Vite 5.x - Fast Front-end Build Tool with Hot Module Replacement (HMR)
  • Tailwind CSS 4.x - Utility-first CSS Framework for efficient UI development

System Requirements

  • DDEV - Ensure DDEV is installed for smooth local development

Key Features

  • Template System

    • Pre-structured layout templates with base layouts, global headers, footers, and page templates
    • Custom error pages for 404, maintenance, and generic errors
  • Configuration Management

    • Pre-configured settings for Craft CMS and essential plugins
  • Optimized Build Process

    • Hot Module Replacement (HMR) for real-time front-end updates
    • Automatic minification and purging of CSS and JS for optimized performance

Included Plugins

Craft CMS Plugins

  • Vite - Integrated front-end build tool for streamlined development
  • Sprig - Enables reactive, interactive components within Twig templates

Installation

  1. Create a project directory and move into it:
mkdir my-craft-project
cd my-craft-project/
  1. Create DDEV configuration files:
ddev config --project-type=craftcms --docroot=web
  1. Start DDEV:

Firstly, edit .ddev/config.yaml and change the name to your project name.

ddev start
ddev exec npm install
ddev composer install
ddev exec php craft install

Authors