Boilerplate-kirby

Opinionated boilerplate for Kirby 4, built on top of kirby-vite-multi-page-kit

Requirements

• Composer
• Node >= 18
• PHP >= 8.3.0

Installation

Use this template.

$ composer install
$ yarn install

Usage

$ yarn start
$ composer update getkirby/cms

Deployment

Deployment is done automatically via a Github action. Simply create a new release by running:

$ yarn version

First deployment

Setup workflow variables

Go to your repo settings and create the necessary variables and secrets for the release workflow:

variables / 
  FTP_SERVER
  REMOTE_DIR

secrets / 
  FTP_USERNAME
  FTP_PASSWORD

Manual transfer

Some directories are not under version control. Deployment for those directories should be done manually.

├── content
├── kirby
├── public
├── site
│ ├── config/vite.config.php
│ └── plugins/*
├── storage
└── vendor

Troubleshooting

If you encounter a bug Error: Client is closed because read ECONNRESET (data socket), create an empty .ftp-deploy-sync-state.json to the root folder you try to publish to.

Server requirements

php.ini

extension=php_intl.dll
extension=intl

Versioning

Because this is a boilerplate and not a library it doesn’t use semantic versioning.

Credits

Built on top of kirby-vite-multi-page-kit.

License

MIT.