Minimal Kirby 3 starterkit
Technologies
Requirements
Make sure to have Node, and Composer installed
- Install or update Homebrew to the latest version
brew update
- Install PHP
brew install php
- Install Composer
Installation
- Install npm dependencies
npm install
cd
into thewww
folder- Install composer dependencies
composer install
. It will install the Kirby core package - Run
composer update
to update Kirby to the latest version - Update
user.config.js
- Run
npm run watch
to start a dev server
Note: To serve your site on a local environment you might want to use Laravel valet which supports Kirby out of the box
Project structure
KirbyKit uses a custom folder structure where private folders remain outside of the document root
kirbykit/
│
├── resources/
│
├── www/
│ │
│ ├── content/
│ ├── kirby/
│ ├── public/
│ │ ├── assets/
│ │ ├── media/
│ │ ├── .htaccess
│ │ └── index.php/
│ ├── site/
│ ├── storage/
│ │ ├── accounts/
│ │ ├── cache/
│ │ └── sessions/
│ └── ...
│
├── user.config.json
├── webpack.mix.js
└── package.json
Deployment
- Run
npm run prod
to minify and bundle your assets - Deploy the
www
folder to your server