Template repository for Kirby CMS websites. Featuring opinionated configuration, some plugin dependencies, and a setup script for quick installation. Built to use with run-of-the-mill shared hosting providers.
Feel free to use this as a template or inspiration for your own projects. This boilerplate is intended for my personal use and I won't take responsibility if something doesn't work as intended 🍪
setupscript to get started from the CLI without much configuration/public/directory intended to work as the root directory on any live server, while the entire kit can remain under version control- deployment with rploy
- uses pnpm to save disk space
- Laravel Mix with BrowserSync enabled and configured
- rploy and Kirby-specific configuration for rapid deployment
- SASS preinstalled
- Tailwind preinstalled
- Alpine.js preinstalled
site/snippets/global/header.php: contains opening html and body tags and links to default assets, and an Emoji faviconsite/snippets/global/footer.php: contains closing html and body tagssite/config/config.php: automatically enables debug mode if an admin user is logged insite/config/routes.php: if aprelaunchoption is set, the site will be hidden for the public and all requests are redirected to the login screensite/plugins/.gitignore: allows prefixing custom plugins with "my-" to automatically be included in the git repo
- Create a new repository from this template
- Donwload or clone your repository and navigate to the directory
- run
bash setup
The walkthrough script will (1) install all dependencies, (2) valet link the site if it's not already in a parked directory, (3) prompt for the title of the site and an email/password combination to install the panel, (4) create a .env file in the public directory and create a local config file with appropriate settings. It is of course possible to do all this manually.
pnpm run dev to start local dev server with hot reload.
pnpm run deploy to bundle assets and deploy to server using rploy.
⚠️ The template also contains sensitive PHP scripts, such asauthenticate.phpwhich authenticates as almighty. It is not recommended to sync anything but thepublicdirectory to a production environment.
pnpm run push to lazily push everything to remote repository (consider writing meaningful commit messages instead).
(...that i may or may not have taken inspiration from)
- Forge Lite Kirby https://github.com/HashandSalt/ForgeLiteKirby
- Murby https://github.com/FNGR2911/murby
- Anotherkit https://github.com/Diverently/anotherkit
- Kirby Webpack https://github.com/brocessing/kirby-webpack
- Kirby 3 With Public Folder Kit https://github.com/bnomei/kirby3-with-public-folder-kit
- Mix Build Kit https://github.com/floriankarsten/kirby3-mix-build-kit
- Kirby Plainkit Cookiecutter https://github.com/beste/kirby-plainkit/
- k3 Projectkit https://github.com/rasteiner/k3-projectkit
- Coralic Kirby Plainkit https://github.com/coralic/kirby-plainkit
- KAT Kit https://github.com/whiterussianstudio/kat-kit
Kirby is a file-based CMS. Easy to setup. Easy to use. Flexible as hell.
You can try Kirby on your local machine or on a test server as long as you need to make sure it is the right tool for your next project.
You can purchase your Kirby license at https://getkirby.com/buy
A Kirby license is valid for a single domain. You can find Kirby's license agreement here: https://getkirby.com/license