kirby-moin/README.md

43 lines
922 B
Markdown
Raw Permalink Normal View History

2025-08-26 12:17:03 +02:00
# Kirby MOIN! Starterkit
2025-08-22 10:18:22 +02:00
2025-08-26 12:17:03 +02:00
This startkit is based on the plainkit, but comes with the following adjustments:
2025-08-22 10:18:22 +02:00
2025-08-26 12:17:03 +02:00
- 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
2025-08-22 10:18:22 +02:00
The `serve` command is inspired by the `symfony serve` command.
2025-08-26 12:17:03 +02:00
## Requirements
2025-08-22 10:18:22 +02:00
2025-08-26 12:17:03 +02:00
- nodejs/npm
- php8.1+
- [Kirby CLI](https://github.com/getkirby/cli)
- composer
2025-08-22 10:18:22 +02:00
2025-08-26 12:17:03 +02:00
## Install
2025-08-22 10:18:22 +02:00
2025-08-26 12:17:03 +02:00
```bash
composer install
npm install
```
2025-08-22 10:18:22 +02:00
2025-08-26 12:17:03 +02:00
## Start local environment
2025-08-22 10:18:22 +02:00
2025-08-26 12:17:03 +02:00
There is a command extension `serve` for the Kirby CLI. This will spawn a PHP Development
Server, Tailwind CSS and a Webpack watcher.
2025-08-22 10:18:22 +02:00
2025-08-26 12:17:03 +02:00
```bash
kirby serve
```
2025-08-22 10:18:22 +02:00
2025-08-26 12:17:03 +02:00
## Production ready bundle
2025-08-22 10:18:22 +02:00
2025-08-26 12:17:03 +02:00
Run the following command. This will build the css and js into the public folder.
2025-08-22 10:18:22 +02:00
2025-08-26 12:17:03 +02:00
```bash
npm run build
```