madebyshape/craft-cms

Maintainers

Package info

github.com/madebyshape/craft-cms

pkg:composer/madebyshape/craft-cms

Statistics

Installs: 605

Dependents: 0

Suggesters: 0

Stars: 107

Open Issues: 0

Security

Advisories: 0

Aikido package health analysis

5.2.2 2026-04-08 08:35 UTC

Requires

Requires (Dev)

MIT 5e9b881d87d0f9eebf16b784da8bca903fda75c6

This package is auto-updated.

Last update: 2026-04-08 08:58:33 UTC

README

Craft CMS 5 Starter

This is a Craft CMS 5.x starter that MadeByShape use internally for projects. We open sourced it so anybody can use it.

The Stack

Requirements

Features

  • Templates
    • Layout templates setup ready with header and footer globals
    • Exception templates for 404, offline/maintenance and generic errors
    • Page templates setup for use with matrix fields
    • Email template for sending prettier system emails (Forgot password etc)
  • Config
    • Configs for all Craft CMS plugins
    • Customised general config with required features that hook into .env vars
  • Env
    • Customised .env file with Servd and Mailgun included
  • Building
    • HMR
    • CSS and JS minified and purged
    • Favicon is generated and auto-inserted into the template
    • Images compressed
    • Sourcemaps generated
  • Servd
    • Setup to be used with Servd hosting platform
    • Enabled for using static caching
  • Craft Cloud
    • Setup to be used with Craft Cloud hosting provider
    • Enabled for using artifacts with Vite JS and Imager X
  • Caching
    • Uses Blitz to handle server caching and warming
  • Device Testing
    • Test on phones and tablets via Tailscale Share or Funnel
    • Vite dev server assets served through the tunnel

Plugins

Craft CMS

  • Blitz
  • CKEditor
  • Formie
  • Imager X
  • Mailgun
  • Minify
  • SEOMatic
  • Servd Assets and Helpers
  • Craft Cloud Extension
  • Imager X Craft Cloud Transformer
  • Sprig
  • Vite

Install

Create an empty folder and cd to it in your terminal (if you plan to use Option 1 or 2).

1a. Option 1: Composer

If you have Composer installed locally, open your terminal and run:

composer create-project madebyshape/craft-cms

1b. Option 2: Git

You can clone the repo from GitHub using the Git CLI:

git clone git@github.com:madebyshape/craft-cms.git

1c. Option 3: Manual

Download a copy of this repo to your computer using the Code button above, and choosing Download ZIP. Move these files to your empty folder.

2. Start DDEV, Install Craft CMS and dependencies

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

Then, there are a few CLI commands (See more) we've created that allow starting DDEV, installing Craft CMS and installing dependencies (Node particularly). The one to get you started:

make install

3. Starting Vite

Once step 2 has successfully completed, start Vite for front-end tooling:

make dev

Production

When you're ready to go live, make sure you have npm installed on the server, then run the production command to minify, compress and build the front-end assets:

npm run build
# or
make prod

CLI commands

We've created a few commands to make development easier. All commands are run in your terminal:

Command Description
make install Full install (DDEV, Craft CMS, npm)
make setup Pull latest + install dependencies
make start Start DDEV + Vite
make dev Start Vite dev server
make prod Build front-end assets for production
make update Update Craft CMS + plugins
make up Apply project config + migrations
make npm-install Install npm packages
make keys Generate Craft security keys
make pull-db Pull remote database (Servd)
make import-db file=... Import a SQL dump
make update-search-index Rebuild search index
make l Open site in browser
make tp Open TablePlus
make mp Open Mailpit
make share Share site via Tailscale (private)
make funnel Share site via Tailscale Funnel (public)
make clean Reset vendor + node_modules
make clean-logs Clear log files
make kill-vite Kill Vite processes

Nice to know

Device Testing with Tailscale

You can test your local site on other devices (phones, tablets) using Tailscale. This gives you a real HTTPS URL that works on any device.

  • Tailscale installed and running on your Mac (the standalone or Homebrew version, not the Mac App Store version)
  • Funnel requires HTTPS certificates and the funnel node attribute enabled in your Tailscale admin console

The Tailscale commands (see CLI commands) automatically register the Tailscale hostname with DDEV's router and expose the Vite dev server so CSS/JS assets load correctly on remote devices. You'll need two terminals: one for the Tailscale tunnel and one for Vite.

File system type

The file system type is set in the .env file. It can be set to either local, servd or craftCloud depending on where you are hosting your project. local is good for local and also production if the files are hosted on the same server.

FILESYSTEM_TYPE=local

Database

To access the database inside the DDEV environment, you can use TablePlus. You can use the following command to open TablePlus to export/import:

ddev tableplus
# or
make tp

Email

To access the email inside the DDEV environment, you can use Mailpit. You can use the following command to open Mailpit:

ddev mailpit
# or
make mp

HTTPS recommended

There are a few issues getting Vite, DDEV and Craft CMS running nicely together over HTTP, so always make sure you are using HTTPS. For DDEV just run:

ddev stop --all
mkcert -install
ddev start
ddev launch