https://github.com/johannschopplich/kirby-headless

🦭 Kirby, but headless first with bearer token authentication and KQL utilities
https://github.com/johannschopplich/kirby-headless

headless kirby-cms kirby-plugin kirby-theme

Last synced: 2 days ago
JSON representation

🦭 Kirby, but headless first with bearer token authentication and KQL utilities

• Host: GitHub
• URL: https://github.com/johannschopplich/kirby-headless
• Owner: johannschopplich
• License: mit
• Created: 2022-12-28T14:15:46.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-27T11:58:04.000Z (about 2 months ago)
• Last Synced: 2024-11-14T18:04:09.896Z (2 days ago)
• Topics: headless, kirby-cms, kirby-plugin, kirby-theme
• Language: PHP
• Homepage: https://kirby.tools/docs/headless
• Size: 395 KB
• Stars: 32
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
![Kirby Headless Preview](./.github/og.png)

# Kirby Headless

This plugin is designed for developers who want to use Kirby's backend to serve content to a frontend application, static site generator, or mobile application. You can either add headless functionality to your existing Kirby site, or use this plugin to build a headless-first CMS from scratch.

> [!NOTE]

> Check out to the [Kirby Headless Starter](https://github.com/johannschopplich/kirby-headless-starter) repository for a ready-to-use headless-only setup!

## Key Features

- 🧩 Optional bearer token authentication for [KQL](https://kirby.tools/docs/headless/usage#kirby-query-language-kql) and custom API endpoints

- 🧱 Resolve fields in blocks: [UUIDs to file and page objects](https://kirby.tools/docs/headless/field-methods) or [any other field](https://kirby.tools/docs/headless/field-methods)

- ⚡️ Cached KQL queries

- 🌐 Multi-language support for KQL queries

- 😵 Built-in CORS handling

- 🍢 Express-esque [API builder](https://kirby.tools/docs/headless/api-builder) with middleware support

- 🗂 Return [JSON from templates](https://kirby.tools/docs/headless/usage#json-templates) instead of HTML

## Installation

> [!TIP]

> [📖 Read the documentation](https://kirby.tools/docs/headless#installation)

### Composer

The recommended way to install the plugin is via Composer. To install the plugin, run the following command in your terminal:

```bash

composer require johannschopplich/kirby-headless

```

### Download

Head over to the [releases page](https://github.com/johannschopplich/kirby-headless/releases) and download the latest version of the plugin as a ZIP file. Extract the contents of this ZIP file to your `site/plugins` folder. It should look like this:

```

site/plugins/

├─ kirby-headless/

│  └─ … Plugin files

```

## Usage

> [!TIP]

> [📖 Read the documentation](https://kirby.tools/docs/headless/usage)

## License

[MIT](./LICENSE) License © 2022-PRESENT [Johann Schopplich](https://github.com/johannschopplich)