diff --git a/README.md b/README.md index 7a643f1..5d471bf 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,111 @@ -- Allows to use Valet and DDEV togehter over differet ports (https://www.eddiedale.com/blog/using-laravel-valet-at-the-same-time-as-ddev) -- Vite 5 -- Craft CMS 5 -- Tailwind 3 -- PostCSS (Instead of previous SASS/SCSS) -- Favicon -- Image compression -- Fonts and font face -- Load via // E.g. @import 'components/lazyLoad.pcss'; CSS -- Load via // import "./components/lazyLoad"; JS -- {# Use {{ vars.class.gap.x }} #} -- Pro License \ No newline at end of file +# 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 + +- [Craft CMS 5.x](https://craftcms.com) Content management system +- [DDEV](https://ddev.com) Local development environment +- [Vite 4.x](https://vitejs.dev) Front end build tool with HMR +- [Tailwind CSS 3.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 + +## Requirements + +- [Docker](https://www.docker.com) +- [DDEV](https://ddev.com) + +## 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 +- Caching + - Uses Blitz to handle server caching and warming + +## Plugins + +### Craft CMS + +- Blitz +- Hyper +- SEOMatic +- Vite +- Sprig +- Formie +- Imager X +- Minify +- CKEditor +- Mailgun +- Servd Asset Storage + +### Tailwind CSS + +- Aspect Ratio + +## Install + +Create an empty folder and CD to it in terminal (If you plan to use Option 1 or 2). + +### 1a. Option 1: Composer + +If you have composer installed locally, open terminal and run: + +`composer create-project madebyshape/craft-cms` + +### 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 + +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 + +There are a few CLI commands (See below) 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 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` + +## CLI commands + +We've create a few commands to make development easier. All these commands are ran in terminal: + +| Command | Description | +| -------- | ------- | +| `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 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 update` | Smaller command that runs `ddev exec php craft update all` | + +## Nice to know + +## Roadmap \ No newline at end of file