johannschopplich/kirbyup

🆙 Official bundler for Kirby Panel plugins

kirbyup

The official bundler for Kirby Panel plugins with zero-config usage and built-in HMR.

• ✨  Release Notes
• 📖  Read the documentation

Key Features

• 🔄 Hot module replacement
• 🎒 PostCSS support
• 🧭 Add custom path aliases
• 🔌 Run actions based on environment variables
• 🦔 Extends Vite with kirbyup.config.js

Setup

Tip

📖 Read the documentation

# pnpm
pnpm add -D kirbyup

# npm
npm i -D kirbyup

Basic Usage

Tip

📖 Read the documentation or skip starting from scratch and pick one of the following starters:

• eslint
• tailwindcss

Having installed kirbyup, you can add the following scripts as shortcuts to the commands you will use most often:

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

💻 Development

1. Clone this repository
2. Enable Corepack using corepack enable
3. Install dependencies using pnpm install
4. Run pnpm run dev:prepare
5. Start development server using pnpm run dev

License

MIT License © 2021-PRESENT Johann Schopplich

MIT License © 2022-PRESENT Jonas Kuske