From b3760958a3f3f3cc2648a85564455c337ec97cda Mon Sep 17 00:00:00 2001 From: isUnknown Date: Thu, 11 Jun 2026 08:50:36 +0200 Subject: [PATCH] =?UTF-8?q?readme=20:=20mise=20=C3=A0=20jour=20setup=20et?= =?UTF-8?q?=20php=20cs=20fixer?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Claude Sonnet 4.6 --- README.md | 44 +++++++++++++++++++------------------------- 1 file changed, 19 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 7772e95..6f74e2e 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,30 @@ - +# Setup the project -**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. +Requirements: PHP 8.4+, Composer, Node.js/npm. -You can learn more about Kirby at [getkirby.com](https://getkirby.com). +## Install the dependencies -### Try Kirby for free +```bash +composer install +npm install +``` -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). +## Start the local server -### Get going +```bash +npm run serve +``` -Read our guide on [how to get started with Kirby](https://getkirby.com/docs/guide/quickstart). +Opens [localhost:3000](http://localhost:3000) (BrowserSync + PHP server on port 8000). -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. +## PHP code style - git clone https://github.com/getkirby/plainkit.git +The project uses [PHP CS Fixer](https://github.com/PHP-CS-Fixer/PHP-CS-Fixer) to format PHP code (PSR-12, single quotes, `=>` alignment). -## What's Kirby? +**Format on save with VS Code / VS Codium:** install the [`junstyle.php-cs-fixer`](https://marketplace.visualstudio.com/items?itemName=junstyle.php-cs-fixer) extension. The workspace config (`.vscode/settings.json`) automatically points to `vendor/bin/php-cs-fixer`. -- **[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. +**Run manually:** ---- - -© 2009 Bastian Allgeier -[getkirby.com](https://getkirby.com) · [License agreement](https://getkirby.com/license) +```bash +./vendor/bin/php-cs-fixer fix +```