Git Product home page Git Product logo

kirby-headless's Introduction

Kirby as a Headless CMS

For instructions on how to get started with Kirby, see getkirby.com/docs/guide/quickstart.
For KQL Plugin documentation, see github.com/getkirby/kql.

Overview

.
└── site
    ├── blueprints
    │   └── users
    │       ├── api.yml
    │       └── default.yml
    ├── config
    │   └── config.php
    └── plugins
        └── kql

Prerequisites

PHP and Composer

Replicate

Assuming the official Plainkit or Starterkit as a starting point.

  1. Install Kirby dependencies: composer install.
  2. Install the KQL plugin: composer require getkirby/kql.
  3. Set up authentication:
  • Create an API user and set user permissions in /site/blueprints/users. For more information, see documentation on roles and permissions.
  • Set up Basic Auth. Modify /site/config/config.php:
return [
  'api' => [
    'basicAuth' => true,
    'allowInsecure' => true # TODO: remove pre-production
  ]
];
  1. Startup a local PHP server: composer start (or use an alternative: Laravel Valet/MAMP/…).
  2. Go to the Panel ({url}/panel) and create an API user. Further, use these credentials to authorize requests to your API.

Quick Setup

  1. Clone/download this repository.
  2. Run in terminal:
composer install
composer start
  1. Implement step 5 above.

Potentially useful tools

Insomnia (testing)

kirby-headless's People

Contributors

stuymedova avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.