Heavily opinionated starter kit for CraftCMS Projects.
- Laravel Valet (https://laravel.com/docs/8.x/valet)
- PHP 8.0
- MySQL 8 / MariaDB
- optional: Redis
brew install redis
- Duplicate the
.env.example
file as.env
and do your settings
Use the seed_db.gz
as starting point. Create a new database with the settings from your .env
file and import the seed_db.gz
into it. The login credentials are: superuser:superuser
Go to ./
and do this: valet link craftcms-baukasten
to create a domain like craftcms-baukasten.test
(Info: Use the domain you used also in the .env file
)
redis-server --daemonize yes
it's totally optionalnpm run dev
start local dev servernpm run upgrade-interactive
To get an interactive GUI to update NPM Packagesnpm run twc
creates atailwind.app.css
file in./src/css/
Assets must be in src/public/
to be copied to web/dist
folder.
<img class="w-12 h-12" src="{{ craft.vite.asset('images/svg/logo.svg', true) }}" alt="">
{% set asset = craft.vite.asset('images/svg/logo.svg', true) %}
{{ craft.vite.inline(asset) }}
Asset: Alt Text (Plain Text)
: Alt text per assetAsset: Caption (Plain Text)
: Caption per assetAsset: Source (Plain Text)
: Source per assetAsset: Source Url (URL)
: Source Url per assetAsset: Title (Plain Text)
: Title per assetBuilder: Content (Matrix)
: Content Builder to create custom entry contentSection
: Create blocks of contentText
: Create Rich Text ContentText : Floating Image
: Create rich text content with a floating imageQuote
: Create QuotesImage
: Create a imageImage Grid
: Create a image gridImage Grid Calculated
: Create a image grid with calculated sizesImage Gallery
: Create a image galleryYoutube Video
: Create a youtube embedDivider
: Create a dividerSpacer
: Create a spacer
Entry: Custom Title (Plain Text)
: Overwrite the normal title (more declarative)Entry: Image (Assets)
: The entry image is used for SEO images and if the entry is linked in a card where an image is shown.Entry: SEO (SEO Settings)
: Custom SEO Settings on entry levelEntry: Short Description (Plain Text)
: Used for SEO or also for linked entries somewhereText Advanced (Redactor)
: Advanced Rich Text experienceText Basic (Redactor)
: Basic Rich Text experience
Home (Single)
: This is the root of your webpageNews (Channel)
: A channel to create newsContent Builder (Entry Type)
: Entry type for news with a content builder
Pages (Structure)
: A structure to create structured pages for your webpageContent Builder (Entry Type)
: Entry type for pages with a content builderOverview News (Entry Type)
: Entry type for the news overview page
Error Pages (Channel)
: To create maintainable error pages like 404
Files
: Where files like pdf etc. livesImages
: Where our content images livesTemplate Images
: Where our template images livesUsers
: Where our user images lives
Blitz (paid)
: Blitz provides intelligent static page caching for creating lightning-fast sites with Craft.Blitz Recommendations (free)
: Adds a utility that provides templating performance recommendations.CP Clear Cache (free)
: Less clickin’ to get clearin’CP Field Inspect (free)
: Inspect field handles and easily edit field and element source settingsControl Panel CSS (free)
: Add custom CSS to your Control Panel.Dumper (free)
: Bringing larapack/dd to Craft 3Elements Panel (free)
: Adds an Elements and an Eager-Loading panel to the debug toolbar.Empty Coalesce (free)
: Empty Coalesce adds the ??? operator to Twig that will return the first thing that is defined, not null, and not empty.Formie (paid)
: Formie is a Craft CMS plugin for creating user-friendly forms that your content editors will love.Imager X (paid)
: Ninja powered image transforms.Minify (free)
: A simple plugin that allows you to minify blocks of HTML, CSS, and JS inline in Craft CMS templates.Navigation (paid)
: A Craft CMS plugin to create navigation menus for your site.Redactor (free)
: Edit rich text content in Craft CMS using Redactor by Imperavi.SEOmatic (paid)
: SEOmatic facilitates modern SEO best practices & implementation for Craft CMS 3. It is a turnkey SEO system that is comprehensive, powerful, and flexible.Sprig (free)
: A reactive Twig component framework for Craft.Super Table (free)
: Super-charge your Craft workflow with Super Table. Use it to group fields together or build complex Matrix-in-Matrix solutions.Typed link field (free)
: A Craft field type for selecting linksVite (free)
: Allows the use of the Vite.js next generation frontend tooling with Craft CMS
I have developed several CraftCMS projects the last few years. For me, the setup and certain basics are what tend to take time away from me at the beginning of the project.
For this reason there is the "Baukasten" to get started faster in new projects. It's a collection of good practices I have learned and adopted from past projects and from other people. It's heavily opinionated, but feel free to fork and modify it for your own needs.