README

This is a starter Craft CMS v5.X setup for site built by TILT. It is opinionated in the sense that it is configured to make use of the following stack:

• DDEV as the local dev server
• Vite for handling of HMR, and front end build features
• SASS/PostCSS for CSS processing
• Alpine JS for Javascript

Installation Instructions

ONLY DO THIS IF YOU ARE CREATING A NEW PROJECT You only need to install the boilerplate if you are the one initiating the build process on a project. If you aren't, whoever did initiate it should have created a repository on Tilt's GitHub account for the new site. Simply clone that repository and then create a blank database and run the composer update command from inside the project folder, followed by the the ./craft install command.

Download Files

First you need to run the command to download the package files. Open the terminal and go to the folder where you keep all of your sites. Once there, run the following command:

composer create-project tiltbuilt/boilermaker-tr my/project/path --no-install

Where the project path part is replaced with the name of the folder for the project you are creating (usually the name of the client website, all lower case, no spaces. hyphens and underscores are allowed). The folder needs to be empty.

Configure DDEV

** DO NOT SKIP THIS STEP ** If you want your site to run on a domain other than https://craftcms.ddev.site, run:

ddev config

Use the following settings:

Project name: e.g. mysite would result in a project URL of https://mysite.ddev.site (you will need this later) Docroot location: keep as-is, web is the default Project Type: keep as-is, php is the default

** When the config is finished, you should then run ddev start. **

ddev start

Installing Craft

To install a clean version of Craft, run:

make install

Follow the prompts.

This command will:

1. Copy your local SSH keys into the container (handy if you are setting up craft-scripts)
2. Start your DDEV project
3. Install Composer
4. Install npm
5. Do a one-time build of Vite
6. Generate APP_ID and save to your .env file
7. Generate SECURITY_KEY and save to your .env file
8. Installing Craft for the first time, allowing you to set the admin's account credentials
9. Install all Craft plugins

** IMPORTANT - Use the following settings when running the Craft installer for the database settings ** Database Server: DB Database: DB Database User: DB Database Password: DB Database Port: 3306 Database Prefix: leave blank

Once the process is complete, type ddev launch to open the project in your default browser. 🚀

Local development with Vite

To begin development with Vite's dev server & HMR, run:

ddev start

This command will:

1. Copy your local SSH keys into the container (handy if you are setting up craft-scripts)
2. Start your DDEV project
3. Install Composer
4. Install npm
5. Do a one-time build of Vite
6. Spin up the Vite dev server

Open up a browser to your project domain to verify that Vite is connected.

Makefile

A Makefile has been included to provide a unified CLI for common development commands.

• make install - Runs a complete one-time process to set the project up and install Craft.
• make build - Builds all front-end assets.

Craft CMS Plugins

1. Blitz
2. Button Box
3. CK Editor
4. Cloner
5. Colour Swatches
6. Color Mixer
7. Critter
8. DataStar
9. Default Dashboard
10. Element Index Defaults
11. Embedded Assets
12. Expanded Singles
13. Feed-Me
14. Field Manager
15. Formie
16. Icon Picker
17. Imager-X
18. Imager-X ImgIX Download Transformer
19. Imager-X Power Pack
20. Knock Knock
21. Minify
22. Navigation
23. Postmark
24. Retcon
25. Retour
26. Section and Product Type
27. Seomatic
28. Servd Assets and Helpers
29. Shortcodes
30. Social Share
31. Table Maker
32. Typogrify
33. Vite

Javascript Libraries

1. AlpineJS
2. Swiper
3. GSAP

Acknowledgments

This project is based upon the work of a lot of people including the entire team at Craft CMS, Andrew Welch of NY Studio 107, Ryan Irelan of CraftQuest, the team at One Darnley Road and others. A big thank you to all of you for the work you have done and the fact that you are so willing to share it with the community. I could not have gotten this done without the insights and examples you have all provided. I also want to thank the team at TILT for their ongoing support and dedication to making great sites. My thanks to you all!