webrgp / craftcms-starter

craftcms-starter

craftcms-starter

Overview

craftcms-starter is a project starter tool designed to streamline the setup process for a Craft CMS project with a modern development environment. This tool integrates a Makefile, Docker, DDEV, Craft CMS, ViteJS, and Tailwind CSS to provide a seamless setup experience for your team.

The git repository for the tool can be found at https://github.com/dative/craftcms-starter.

Notable Features

• DDEV for local development
• Craft CMS 4.x for content management
• Vite 4.x for front-end bundling & HMR
• Tailwind 3.x for utility-first CSS
• Alpine 3.x for lightweight reactivity
• Makefile for common CLI commands

Prerequisites

Before using the craftcms-starter tool, make sure you have the following installed:

• Docker
• DDEV, minimum version v1.21.6

Getting Started

Commands

To set up a new project, run the following command in your terminal:

make install

This command executes three individual tasks sequentially: install-ddev, install-buildchain, and install-cms. You can also run these tasks individually if needed.

install-ddev

This task sets up the DDEV environment for the project. To run this task individually, use:

make install-ddev

install-buildchain

This task sets up the build chain, which includes ViteJS and Tailwind CSS. To run this task individually, use:

make install-buildchain

install-cms

This task sets up the Craft CMS environment, including the necessary configuration files and templates. To run this task individually, use:

make install-cms

Template System

The craftcms-starter comes with an opinionated base template system that is designed to get you up and running quickly. You can use the templates as-is, or you can customize them to your project needs.

To learn more about the template system, see the Template System section below.

Customization

You can customize the setup process by modifying the Makefile variables. Uncomment and set the following variables to override the default values:

• CRAFT_PATH: The path where the Craft CMS files will be located.
• DDEV_PATH: The path where the DDEV files will be located.
• SRC_PATH: The path where the source files (CSS, JS, and others) will be located.
• DEFAULT_SITE_NAME: The default name for the site.
• ADMIN_USERNAME: The default admin username.

For example, to change the default Craft CMS path to my-cms, you can update the Makefile as follows:

CRAFT_PATH := my-cms

After updating the variables, run the setup-project command to apply the changes.

Testing

git submodule init git submodule update --init

https://github.com/ddev/github-action-setup-ddev

Roadmap

• Add support for Windows WSL

Contributing

Coming Soon