README

Features

• ⚡️ Uses Vite with kirby-vite plugin
• 📚 Multiple pages
• 🔄 Live Reloading for Kirby templates, snippets, content, ... changes
• 📂 Public folder structure

Installation

Clone this repository and run:

composer install

npm install

Development

Start vite's dev server and a simple php dev server by running:

npm run dev

Visit localhost:8888 in the browser. Vite's dev server (localhost:5173) is only used for serving js, css and assets.

Preview

Get a local production preview by running:

npm run preview

Production

Build your optimized frontend assets to public/dist:

npm run build

File Nesting

If your are using VS Code, you can add file nesting to visually organize your assets in the editor's file explorer:

// .vscode/settings.json
{
  "explorer.fileNesting.enabled": true,
  "explorer.fileNesting.patterns": {
    "*.js": "${capture}.css"
  },
}

Deployment

Manually

Upload the repository to your web server and point your web server to the repository's public folder.

Rsync

If you have ssh access you can use rsync to automate the upload/sync.

Git

You can also deploy your repository with git. Then you have to run the installation steps again on your web server.

Versioning

Because this is a started kit and not a library it doesn't use semantic versioning. If you wan't to migrate an existing project please look for any breaking changes in the release note.