kirbyup

The official bundler for Kirby Panel plugins. Zero-config, built-in HMR.

• ✨  Release Notes
• 📖  Read the documentation

Key Features

• 🔄 Hot Module Replacement
• 🎒 PostCSS & Sass
• 🧩 kirbyuse Integration
• 🔌 Environment Variables
• 🦔 Configuration File
• 🧭 Path Aliases

Requirements

• Node.js 22 or newer with pnpm, npm or yarn.
• Kirby 4 or newer. kirbyup 3 builds for the Vue 2 Panel of Kirby 4 and 5.

Setup

Tip

Skip the setup with one of the starters:

• eslint
• unocss

# pnpm
pnpm add -D kirbyup

# npm
npm i -D kirbyup

# yarn
yarn add -D kirbyup

Add the two scripts to package.json:

{
  "scripts": {
    "dev": "kirbyup serve src/index.js",
    "build": "kirbyup src/index.js"
  },
  "devDependencies": {
    "kirbyup": "^3.5.0"
  }
}

Development

1. Clone this repository
2. Enable Corepack using corepack enable
3. Install dependencies using pnpm install
4. Build with pnpm run build
5. Run tests with pnpm test

License

MIT License © 2021-PRESENT Johann Schopplich

MIT License © 2022-PRESENT Jonas Kuske