PHPackages                             madebyshape/craft-3 - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. madebyshape/craft-3

ActiveLibrary

madebyshape/craft-3
===================

5.1.13(3mo ago)10750721[9 issues](https://github.com/madebyshape/craft-cms/issues)[8 PRs](https://github.com/madebyshape/craft-cms/pulls)MITPHPCI passing

Since Jun 4Pushed 1mo ago8 watchersCompare

[ Source](https://github.com/madebyshape/craft-cms)[ Packagist](https://packagist.org/packages/madebyshape/craft-3)[ RSS](/packages/madebyshape-craft-3/feed)WikiDiscussions master Synced 2mo ago

READMEChangelog (10)Dependencies (16)Versions (123)Used By (0)

[![](https://github.com/madebyshape/craft-cms/raw/master/src/public/images/favicon.png)](https://github.com/madebyshape/craft-cms/blob/master/src/public/images/favicon.png)

Craft CMS 5 Starter
===================

[](#craft-cms-5-starter)

This is a [Craft CMS 5.x](https://github.com/craftcms/cms) starter [MadeByShape](https://madebyshape.co.uk) use internally for projects, that we open sourced so anybody can use it.

The Stack
---------

[](#the-stack)

- [Craft CMS 5.x](https://craftcms.com) Content management system
- [DDEV](https://ddev.com) Local development environment
- [Vite 5.x](https://vitejs.dev) Front end build tool with HMR
- [Tailwind CSS 4.x](https://tailwindcss.com) Utility-first CSS framework
- [Alpine.js 3.x](https://alpinejs.dev/) Minimal JS framework
- [Mailgun](https://www.mailgun.com/) Email API
- [Servd](https://servd.host) Craft CMS first hosting provider
- [Craft Cloud](https://craft.cloud) Craft CMS hosting provider

Requirements
------------

[](#requirements)

- [Docker](https://www.docker.com)
- [DDEV](https://ddev.com)

Features
--------

[](#features)

- Templates
    - Layout templates setup ready with header and footer globals
    - Exception templates for 404, offline/maintenece 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 in to .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

Plugins
-------

[](#plugins)

### Craft CMS

[](#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
-------

[](#install)

Create an empty folder and CD to it in terminal (If you plan to use Option 1 or 2).

### 1a. Option 1: Composer

[](#1a-option-1-composer)

If you have composer installed locally, open terminal and run:

```
composer create-project madebyshape/craft-cms
```

### 1b. Option 2: Git

[](#1b-option-2-git)

You can clone the repo from Github using Git CLI:

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

### 1c. Option 3: Manual

[](#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

[](#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](#cli-commands)) 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

[](#3-starting-vite)

Once you've followed step 2 and it's successfully ran through the steps, you'll need to start Vite which allows you to start using front end tooling:

```
make dev
```

Production
----------

[](#production)

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

```
npm run build
```

CLI commands
------------

[](#cli-commands)

We've create a few commands to make development easier. All these commands are ran in terminal:

CommandDescription`make install`Starts DDEV, Install Craft CMS and dependencies.`make setup`Use when starting to work on your project especially if your working in a team.`make start`Starts DDEV and Vite development process.`make dev`Starts Vite development process.`make prod`Run on production to start Vite build process - minify, compress etc.`make clean`Removes composer and node files ready for a clean install.`make clean-logs`Removes log files from /storage/logs for easier debugging.`make update`Smaller command that runs `ddev exec php craft update all`.`make up` 💅Runs project config apply and migrations apply.`make pull-db`Pulls a database dump from a remote Servd environment into the local database.`make import-db file=/path/to/file.sql.gz`Imports a database dump from a local file into the local database.`make tp`Launches tableplus`make l`Launches the site`make keys`Adds APP\_ID and SECURITY\_KEY keys to .env`make update-search-index`Updates the search index for the project.`make mp`Launches Mailpit for email testing.Nice to know
------------

[](#nice-to-know)

### File system type

[](#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

[](#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

[](#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

[](#https-recommended)

There is 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
```

###  Health Score

57

—

FairBetter than 98% of packages

Maintenance85

Actively maintained with recent releases

Popularity29

Limited adoption so far

Community19

Small or concentrated contributor base

Maturity80

Battle-tested with a long release history

 Bus Factor1

Top contributor holds 97.3% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~26 days

Recently: every ~19 days

Total

109

Last Release

96d ago

Major Versions

1.1.0 → 2.0.02020-06-03

2.0.24 → 3.0.02021-02-25

3.0.7 → 4.0.02022-05-06

4.0.9 → 5.0.02024-04-10

### Community

Maintainers

![](https://www.gravatar.com/avatar/024fcb00b01ff8297b6cc35b50a7bd0e25fac5a15581722a944558b19bc18519?d=identicon)[madebyshape](/maintainers/madebyshape)

---

Top Contributors

[![bymayo](https://avatars.githubusercontent.com/u/522877?v=4)](https://github.com/bymayo "bymayo (544 commits)")[![iamtompickering](https://avatars.githubusercontent.com/u/6592882?v=4)](https://github.com/iamtompickering "iamtompickering (8 commits)")[![akabucko](https://avatars.githubusercontent.com/u/26873231?v=4)](https://github.com/akabucko "akabucko (6 commits)")[![hirasso](https://avatars.githubusercontent.com/u/869813?v=4)](https://github.com/hirasso "hirasso (1 commits)")

---

Tags

alpinejsboilerplatecraftcmscraftcms5tailwindcssvuejs

### Embed Badge

![Health badge](/badges/madebyshape-craft-3/health.svg)

```
[![Health](https://phpackages.com/badges/madebyshape-craft-3/health.svg)](https://phpackages.com/packages/madebyshape-craft-3)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
