Kirby 3 Boilerplate - starter

A simple and basic starter suited for Kirby 3 project, with Gulp + Webpack.
It's made with the Yeho-starter.

Update this Readme file to suit your project.

Information

The project root where the index.php file belong to is set to /public, you can change the configuration in the /gulp_tasks/_helpers.js file.
After a git pull, you probably need to run npm install in case new dependencies are required.
Note: During a Git commit, there is scripts who are running automatically like Prettier, Stylelint and ESLint to fix the code style and formatting.
The /content folder is not committed and empty by default.

Installation

Prerequisites

Please, have an up-to-date version of:

• Git
• Node.js + NPM
• Composer
• Gulp CLI

Steps

1. Clone the repository:

git clone [email protected]:yoanmalie/kirby3-starter.git

2. Launch the installation of dependencies:

npm install
composer install

3. Localhost only:

• If you use a vhost, copy the .example.vhost.js file and name it .vhost.js and type your vhost URL inside.
• To make the Kirby configuration available to fit the multi-environment setup, just copy the file /site/config/config.example.vhost.php and rename it accordingly to your vhost name, like /site/config/config.my-website.local.php.

4. Populate content:

Run the script sh ./scripts/populate-content.sh or copy these files to create the site.txt with the homepage and the error page.

5. Create necessary assets files for the project:

gulp build

Or, the same thing but with a Watch and a Sync which will rerun the tasks again and refresh the browser when there is updated files:

gulp serve

Available commands

To know the available NPM and Gulp commands, run:

npm run # package.json scripts
gulp --tasks # Gulp tasks with details
gulp --tasks-simple # Gulp task simplified

Environments

By default everything is built for a --development environment so assets files are not minified and use the sourcemap, etc.
If you want to build for a production environment, use the --production flag when you run a Gulp command.

Browsers

Browsersync open Google Chrome by default, you can use Firefox instead by using the --firefox flag when you run the gulp sync task or the gulp serve one.

Kirby core and plugins

The /plugins folder is not versioned, if you need to commit a custom plugin add it to the .gitignore file with a leading !: !/site/plugins/my-plugin/

To install a plugin:

composer require yoanmalie/kirbytextwrap

To update Kirby itself:

composer update getkirby/cms

To update a plugin:

composer update yoanmalie/kirbytextwrap

To update everything:

composer update

Know problems:

⚠️ Check your used versions of Git, Node.js, NPM and Gulp CLI.

Node.js

Sometime, problems with Node.js can be simply be solved by cleaning the cache with npm cache clean.

Related to Browsersync

Cannot get/ appear? There is a problem with the vhost. Check if you didn't make a typo in the .vhost.js file and if this vhost URL work well too on your machine.

If you meet the error Error: listen EADDRINUSE, stop the Gulp process in your operating system. Please note to care about if you stop the current running command, do it with CTRL + C.