From 916266b356a1fb67a25de1058e479897df3b0929 Mon Sep 17 00:00:00 2001 From: Stephan Ploehn Date: Tue, 26 Aug 2025 12:17:03 +0200 Subject: [PATCH 1/2] chore: updated README --- README.md | 52 ++++++++++++++++++++++++++++------------------------ 1 file changed, 28 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 7772e95..683794a 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,40 @@ - +# Kirby MOIN! Starterkit -**Kirby: the CMS that adapts to any project, loved by developers and editors alike.** -The Plainkit is a minimal Kirby setup with the basics you need to start a project from scratch. It is the ideal choice if you are already familiar with Kirby and want to start step-by-step. +This startkit is based on the plainkit, but comes with the following adjustments: -You can learn more about Kirby at [getkirby.com](https://getkirby.com). +- Custom folder structure with the document root in the `public` folder +- Tailwind CSS +- Webpack with [Stimulus](https://stimulus.hotwired.dev) and [Turbo](https://turbo.hotwired.dev) +- Kirby CLI Command `serve` +- Plugin that adds "Cache Busting" for JS and CSS files -### Try Kirby for free +## Requirements -You can try Kirby and the Plainkit on your local machine or on a test server as long as you need to make sure it is the right tool for your next project. … and when you’re convinced, [buy your license](https://getkirby.com/buy). +- nodejs/npm +- php8.1+ +- [Kirby CLI](https://github.com/getkirby/cli) +- composer -### Get going +## Install -Read our guide on [how to get started with Kirby](https://getkirby.com/docs/guide/quickstart). +```bash +composer install +npm install +``` -You can [download the latest version](https://github.com/getkirby/plainkit/archive/main.zip) of the Plainkit. -If you are familiar with Git, you can clone Kirby's Plainkit repository from Github. +## Start local environment - git clone https://github.com/getkirby/plainkit.git +There is a command extension `serve` for the Kirby CLI. This will spawn a PHP Development +Server, Tailwind CSS and a Webpack watcher. -## What's Kirby? +```bash +kirby serve +``` -- **[getkirby.com](https://getkirby.com)** – Get to know the CMS. -- **[Try it](https://getkirby.com/try)** – Take a test ride with our online demo. Or download one of our kits to get started. -- **[Documentation](https://getkirby.com/docs/guide)** – Read the official guide, reference and cookbook recipes. -- **[Issues](https://github.com/getkirby/kirby/issues)** – Report bugs and other problems. -- **[Feedback](https://feedback.getkirby.com)** – You have an idea for Kirby? Share it. -- **[Forum](https://forum.getkirby.com)** – Whenever you get stuck, don't hesitate to reach out for questions and support. -- **[Discord](https://chat.getkirby.com)** – Hang out and meet the community. -- **[Mastodon](https://mastodon.social/@getkirby)** – Spread the word. -- **[Bluesky](https://bsky.app/profile/getkirby.com)** – Spread the word. +## Production ready bundle ---- +Run the following command. This will build the css and js into the public folder. -© 2009 Bastian Allgeier -[getkirby.com](https://getkirby.com) · [License agreement](https://getkirby.com/license) +```bash +npm run build +``` From 65364c5fb5a630dbb1f34b52718876a8aa5e528c Mon Sep 17 00:00:00 2001 From: Stephan Ploehn Date: Tue, 26 Aug 2025 12:21:56 +0200 Subject: [PATCH 2/2] chore: updated readme.md and composer.json --- README.md | 2 ++ composer.json | 14 +++++++------- 2 files changed, 9 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 683794a..891eb45 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,8 @@ This startkit is based on the plainkit, but comes with the following adjustments - Kirby CLI Command `serve` - Plugin that adds "Cache Busting" for JS and CSS files +The `serve` command is inspired by the `symfony serve` command. + ## Requirements - nodejs/npm diff --git a/composer.json b/composer.json index 18884c7..92e8800 100644 --- a/composer.json +++ b/composer.json @@ -1,6 +1,6 @@ { "name": "deichrakete/kirby-moin", - "description": "Kirby starterkit with a custom folder structure and Tailwind CSS", + "description": "Kirby starterkit with a custom folder structure, Tailwind CSS and Webpack with Stimulus and Turbo", "type": "project", "keywords": [ "kirby", @@ -13,14 +13,14 @@ "name": "Bastian Allgeier", "email": "bastian@getkirby.com", "homepage": "https://getkirby.com" + }, + { + "name": "Stephan Plöhn", + "email": "ploehn@deichrakete.com", + "homepage": "https://deichrakete.com" } ], - "homepage": "https://getkirby.com", - "support": { - "email": "support@getkirby.com", - "forum": "https://forum.getkirby.com", - "source": "https://github.com/getkirby/plainkit" - }, + "homepage": "https://deichrakete.space/deichrakete/kirby-moin", "require": { "php": "~8.1.0 || ~8.2.0 || ~8.3.0 || ~8.4.0", "getkirby/cms": "^5.0",