mostlyserious/ms-craft

A Craft CMS Starter

v2.6.5 2023-09-25 22:11 UTC

README

A Craft CMS starter used for new sites built by the Mostly Serious team. It's designed to pair with our build tool, Vitepack.

Project Technical Documentation

Software requirements

  • node >= 16.0
  • php >= 8.0.2
  • mysql >= 5.7.8
  • composer >= 2.0

Setup instructions

More detailed instructions can be found in the MS Craft Package Guide.

  • Copy .env.example to .env

  • Install php dependencies

composer install
  • Create mysql database and import a SQL dump

    • You can get a SQL dump from prod by logging into the admin and going to Utilities > Backup Database
  • Fill in the database credentials in the .env file

  • Install front-end dependencies Currently, installation requires Yarn to work properly.

yarn
  • Build front-end dependencies
yarn build

or

npm run build
  • Startup a php server by using Craft's serve command, or use a local .test domain with Laravel Valet.
php craft serve