PHPackages                             locomotivemtl/craft-boilerplate - 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. [Utility &amp; Helpers](/categories/utility)
4. /
5. locomotivemtl/craft-boilerplate

ActiveLibrary[Utility &amp; Helpers](/categories/utility)

locomotivemtl/craft-boilerplate
===============================

A modern CraftCMS project boilerplate.

0.1.2(10mo ago)2251[2 PRs](https://github.com/locomotivemtl/craft-boilerplate/pulls)TypeScriptPHP &gt;=8.2

Since May 16Pushed 1mo ago8 watchersCompare

[ Source](https://github.com/locomotivemtl/craft-boilerplate)[ Packagist](https://packagist.org/packages/locomotivemtl/craft-boilerplate)[ RSS](/packages/locomotivemtl-craft-boilerplate/feed)WikiDiscussions main Synced yesterday

READMEChangelog (1)Dependencies (11)Versions (10)Used By (0)

Craft Project Boilerplate
=========================

[](#craft-project-boilerplate)

The goal of this project is to provide a fully working "boilerplate" (empty skeleton project) using the CraftCMS project.

Table of Content
================

[](#table-of-content)

- [How to Install](#how-to-install)
    - [1. Installing the boilerplate](#1-installing-the-boilerplate)
    - [2. Setup your local environment](#2-setup-your-local-environment)
    - [3. Setup Vite](#3-setup-vite)
    - [4. Setup front-end tools](#4-setup-front-end-tools)
    - [5. Test your installation](#5-test-your-installation)
- [Dependencies and requirements](#dependencies-and-requirements)
- [Development](#development)
    - [Development dependencies](#development-dependencies)
    - [Authors](#authors)

How to Install
==============

[](#how-to-install)

To start a CraftCMS project with this Boilerplate, simply:

1. **Installing the boilerplate**
---------------------------------

[](#1-installing-the-boilerplate)

Use the Composer `create-project` command to install the boilerplate:

```
composer create-project --prefer-dist locomotivemtl/craft-boilerplate acme
```

### Copy environment variables

[](#copy-environment-variables)

Copy the `.env.example.dev` file to `.env`:

2. **Setup your local environment**
-----------------------------------

[](#2-setup-your-local-environment)

### Using Laravel Valet

[](#using-laravel-valet)

```
# Move into your project's directory
cd acme

# Setup valet to use PHP 8.2 only for this project
valet isolate --site acme 8.2

# Install the dependencies
valet composer install

# Run the valet installer.
valet php craft install

# Enable the Vite plugin
valet php craft plugin/install vite
```

### Using DDEV

[](#using-ddev)

```
# Move into your project's directory
cd acme

# Start DDEV
ddev start

# Install the dependencies
ddev composer install

# Run the valet installer.
ddev craft install

# Enable the Vite plugin
ddev craft plugin/install vite
```

3. **Setup Vite**
-----------------

[](#3-setup-vite)

### Using DDEV

[](#using-ddev-1)

DDEV is already setup to run Vite when the container is started.

### Using Laravel Valet

[](#using-laravel-valet-1)

Vite is a fast, modern build tool that speeds up development with instant hot reload and simplifies production bundling using native ES modules.

Add vite configurations to .env file

```
VITE_SERVER_URL="http://localhost"
VITE_SERVER_PORT=5173
# Make sure to set the environment to 'dev'. Otherwise, Craft won't be looking for the Vite server.
CRAFT_ENVIRONMENT=dev
```

4. **Setup front-end tools**
----------------------------

[](#4-setup-front-end-tools)

```
npm install
```

5. **Test your installation**
-----------------------------

[](#5-test-your-installation)

Start your Vite server

```
npm run dev
```

Visit your project locally

Dependencies and Requirements
=============================

[](#dependencies-and-requirements)

- [`PHP 8.2+`](http://php.net)
    - `ext-json`
    - `ext-pdo`
    - `ext-spl`
    - `ext-mbstring`

Development
===========

[](#development)

Tips
----

[](#tips)

A couple of tips have been documented here in `docs/development-tips.md`. Take a look at them before you begin!

Development dependencies
------------------------

[](#development-dependencies)

- [`Node v20.14`](https://nodejs.org/en/blog/release/v20.14.0https://nodejs.org/en/blog/release/v20.14.0)
- [`NPM v10.8.2`](https://www.npmjs.com/)

Authors
-------

[](#authors)

- [Locomotive, a Montreal Web agency](https://locomotive.ca)

###  Health Score

38

—

LowBetter than 83% of packages

Maintenance75

Regular maintenance activity

Popularity10

Limited adoption so far

Community15

Small or concentrated contributor base

Maturity45

Maturing project, gaining track record

 Bus Factor2

2 contributors hold 50%+ of commits

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 ~43 days

Total

3

Last Release

327d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/cfb071c0ff7ce9500c528a003a2c53124248debc3e5bf367c17f89f5e6136125?d=identicon)[mducharme](/maintainers/mducharme)

---

Top Contributors

[![pascalrioux](https://avatars.githubusercontent.com/u/36555872?v=4)](https://github.com/pascalrioux "pascalrioux (29 commits)")[![mcaskill](https://avatars.githubusercontent.com/u/29353?v=4)](https://github.com/mcaskill "mcaskill (21 commits)")[![Jerek0](https://avatars.githubusercontent.com/u/9463158?v=4)](https://github.com/Jerek0 "Jerek0 (13 commits)")[![devenini](https://avatars.githubusercontent.com/u/19838822?v=4)](https://github.com/devenini "devenini (3 commits)")

###  Code Quality

Code StylePHP CS Fixer

### Embed Badge

![Health badge](/badges/locomotivemtl-craft-boilerplate/health.svg)

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

###  Alternatives

[spicyweb/craft-neo

A Matrix-like field type with block hierarchy

393813.5k10](/packages/spicyweb-craft-neo)[verbb/formie

The most user-friendly forms plugin for Craft.

102393.6k70](/packages/verbb-formie)[solspace/craft-freeform

The most flexible and user-friendly form building plugin!

54681.3k19](/packages/solspace-craft-freeform)[verbb/vizy

A flexible visual editor field for Craft.

4250.4k](/packages/verbb-vizy)[verbb/hyper

A user-friendly links field for Craft.

24147.8k12](/packages/verbb-hyper)[verbb/events

A full-featured plugin for event management and ticketing.

2311.9k](/packages/verbb-events)

PHPackages © 2026

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