README

Viget's Craft CMS Starter

Our Craft Site Starter is a quick way to spin up a new Craft CMS project. It's pre-configured with top-notch building tooling, common plugins and starter components based on Blueprint.

If you're a designer or developer at Viget working on a new project, view our Building with Craft Site Starter guide for more information.

Features

Local development powered by DDEV
Vite based front-end build tooling.
Automatic linting, formatting and typechecking
- Runs on git pre-commit hook with Husky
- Only processes staged files using lint-staged
- Prettier, eslint, PHPStan, PHP Easy Coding Standard
Common plugins come pre-installed
Local email is routed through Mailpit ( never worry about emailing a client or user)
Starter components based on Blueprint
A fully accessible header and navigation
A simple Matrix Field based block editor

Getting Started

Create Project

Install DDEV

Choose a folder for your project and move into it:

cd /path/to/web/projects
mkdir my-project
cd my-project

Create The Project If you already have PHP and Composer running on your host machine (your computer, not Docker container or DDEV instance), you can run the following command
```
composer create-project viget/craft-site-starter=^5.0.0 ./ --ignore-platform-reqs
```
If you'd rather not set up PHP, you can create the project with a desposable Docker image (Thanks nystudio107).
```
docker run --rm -it -v "$PWD":/app -v ${COMPOSER_HOME:-$HOME/.composer}:/tmp composer create-project viget/craft-site-starter=^5.0.0 ./ --ignore-platform-reqs
```
Start DDEV & Install Craft
```
ddev start
ddev craft install
```
Run ddev launch to open the project in your browser

Plugins

This starter includes common plugins that we use on most of our sites. This provides consistency and familiarly between client projects. You may not need every plugin, but avoid replacing standard plugins with similar alternatives (unless absolutely necessary).

Contribute to this starter

Local Dev

Ideally, you should be able to clone this repo and make modifications to plugin & build tool configs with minimal fuss.

Run the following and make edits in a feature branch:

ddev start
ddev craft install

See ARCHITECTURE.md for details on technical goals & decisions.

viget / craft-site-starter

Maintainers

Details