https://github.com/johannschopplich/kirbyup

🆙 Official bundler for Kirby Panel plugins
https://github.com/johannschopplich/kirbyup

kirby kirby-cms kirby-panel kirby-plugin

Last synced: 3 days ago
JSON representation

🆙 Official bundler for Kirby Panel plugins

• Host: GitHub
• URL: https://github.com/johannschopplich/kirbyup
• Owner: johannschopplich
• License: mit
• Created: 2021-09-16T22:11:49.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-10-14T16:23:41.000Z (about 1 month ago)
• Last Synced: 2024-10-30T21:05:08.920Z (17 days ago)
• Topics: kirby, kirby-cms, kirby-panel, kirby-plugin
• Language: TypeScript
• Homepage: https://kirbyup.getkirby.com
• Size: 1.59 MB
• Stars: 51
• Watchers: 4
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
[![kirbyup](./docs/public/og.png)](https://kirbyup.getkirby.com)

# kirbyup

[![npm version](https://img.shields.io/npm/v/kirbyup?color=a1b858&label=)](https://www.npmjs.com/package/kirbyup)

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

- [✨  Release Notes](https://github.com/johannschopplich/kirbyup/releases)

- [📖  Read the documentation](https://kirbyup.getkirby.com)

## Key Features

- 🔄 [Hot module replacement](https://kirbyup.getkirby.com/guide/getting-started.html#development)

- 🎒 PostCSS support

- 🧭 Add custom path aliases

- 🔌 Run actions based on environment variables

- 🦔 [Extends Vite with `kirbyup.config.js`](https://kirbyup.getkirby.com/guide/config-file)

## Setup

> [!TIP]

> [📖 Read the documentation](https://kirbyup.getkirby.com)

```bash

# pnpm

pnpm add -D kirbyup

# npm

npm i -D kirbyup

```

## Basic Usage

> [!TIP]

> [📖 Read the documentation](https://kirbyup.getkirby.com) or skip starting from scratch and pick one of the following starters:

> - [`eslint`](./examples/eslint)

> - [`tailwindcss`](./examples/tailwindcss)

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

```json

{

  "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](https://github.com/nodejs/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) License © 2021-PRESENT [Johann Schopplich](https://github.com/johannschopplich)

[MIT](./LICENSE) License © 2022-PRESENT [Jonas Kuske](https://github.com/jonaskuske)