Skip to content

Latest commit

 

History

History
99 lines (63 loc) · 2.81 KB

README.md

File metadata and controls

99 lines (63 loc) · 2.81 KB

Kirby 4 - Playground

Extended version of the Kirby 4 Tutorial.

  • Added plugins inspired by Kirby's learning material from its screencasts, guide, cookbook.
    • Audio block
    • Cards
    • Infobox
    • Testimonials
    • See example pages for more.
  • More example pages.
  • Added Kitchen Sink page type that demonstrates usage of all (?) built-in field types.
  • Added Kirby CLI and kirbyup packages.
  • Updated to Kirby 4.4
  • Dropped multi-language support for now, some translations are still there, but not used.

Thanks to the girls!

Kirby 4 - Tutorial

This is a port of our Craft 4 Tutorial for Kirby CMS.

More of a proof of concept/learning resource than best practice, so some rough edges for now.

Trying to make it easier for devs to switch between Craft and Kirby.

  • Using Twig as templating language
  • Using proven template conventions whenever possible
  • Adding a couple of familiar twig variables/filters
  • Using Laravel Collections
  • Reorganized directory structure
  • Find custom config and translations in familiar places
  • Autocomplete in PhpStorm, including field names (needs manual config, so may be worth it or not...)
  • Demo field types that have no direct equivalent in Craft core (Object, Structure, Layout).
  • Infobox plugin as example for a custom block type
  • Make use of .env file for configuration

Installation

A user with credentials admin@example.com/kirby-tutorial is created during installation.

Goto the panel at /panel.

DDEV

  • Clone repository
  • cd into project directory
  • Run bash setup/install <projectname>

Manual Installation

Untested...

  • Clone repository
  • cd into project directory
  • Set up a webserver pointing to the web directory
  • Run composer install
  • Run cp .env.example .env
  • Run npm install && npm run build

Environment Variables

Just one in .env for now:

ENVIRONMENT=dev

  • enables debugging and disables twig template caching. A bit slower.

ENVIRONMENT=production

  • disables debugging and enables twig template caching. Faster, but you have to clear the storage/cache/twig folder after each update of twig templates.

Screenshots

Frontend

Screenshot home page

Screenshot post index page

Backend

Screenshot Dashboard Screenshot Dashboard

Screenshot Posts

Screenshot Post

Screenshot Post

Screenshot Layout field

TODOS

A lot.

For now, there is only a PoC level handling of responsive images. Needs more in-depth knowledge of Kirby's image handling.