kirby-moin/README.md

40 lines
857 B
Markdown

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