Skip to content
This repository has been archived by the owner on May 11, 2021. It is now read-only.

th-km/kirbykit

Repository files navigation

kirbyKit cover

Minimal Kirby 3 starterkit

Version License

Technologies

Requirements

Make sure to have Node, and Composer installed

  1. Install or update Homebrew to the latest version brew update
  2. Install PHP brew install php
  3. Install Composer

Installation

  1. Install npm dependencies npm install
  2. cd into the www folder
  3. Install composer dependencies composer install. It will install the Kirby core package
  4. Run composer update to update Kirby to the latest version
  5. Update user.config.js
  6. 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

  1. Run npm run prod to minify and bundle your assets
  2. Deploy the www folder to your server