https://github.com/beste/kirby-plainkit

🍪 A Cookiecutter template for a fresh Kirby site
https://github.com/beste/kirby-plainkit

cookiecutter cookiecutter-template kirby kirby-cms kirby-cms-boilerplate

Last synced: 19 days ago
JSON representation

🍪 A Cookiecutter template for a fresh Kirby site

• Host: GitHub
• URL: https://github.com/beste/kirby-plainkit
• Owner: beste
• License: isc
• Created: 2021-04-25T22:32:01.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-02-27T09:45:18.000Z (11 months ago)
• Last Synced: 2024-02-27T11:13:05.020Z (11 months ago)
• Topics: cookiecutter, cookiecutter-template, kirby, kirby-cms, kirby-cms-boilerplate
• Language: PHP
• Homepage: https://getkirby.com
• Size: 13.7 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Kirby Plainkit Cookiecutter

[![Sponsor](https://img.shields.io/static/v1?logo=GitHub&label=Sponsor&message=%E2%9D%A4&color=ff69b4)](https://github.com/sponsors/jeromegamez)

A [Cookiecutter] template to start a fresh [Kirby] site with a [public folder setup].

## Features

* A fresh, git(Hub)-ready plainkit Kirby site

* The site title is already set up

* Run it locally out of the box with [Valet] or with `composer start`

* Media is stored folder is located in `storage/media` folder and symlinked to `public/media`

## Using this cookiecutter

[Install Cookiecutter][Cookiecutter Installation Docs]:

```shell

$ pip install -U cookiecutter

# Or, on a mac with Homebrew

$ brew install cookiecutter

```

Generate a new Kirby site:

```shell

$ cookiecutter gh:beste/kirby-plainkit

```

## See it in action

[![asciicast](https://asciinema.org/a/409907.svg)](https://asciinema.org/a/409907)

## User config

If you use this (or other) Cookiecutters a lot, you can override the defaults by having

a `.cookiecutterrc` file in your home directory:

```yml

default_context:

    full_name: "My full name"

    email: "[email protected]"

    github_username: "mygithubusername"

abbreviations:

    kirby: https://github.com/beste/kirby-plainkit

```

You can find more information at https://cookiecutter.readthedocs.io/en/latest/advanced/user_config.html

[Cookiecutter]: https://github.com/cookiecutter/cookiecutter/

[Cookiecutter Installation Docs]: https://cookiecutter.readthedocs.io/en/latest/installation.html

[Kirby]: https://getkirby.com

[public folder setup]: https://getkirby.com/docs/guide/configuration#custom-folder-setup__public-folder-setup

[Laravel Valet]: https://getkirby.com/docs/cookbook/setup/development-environment#laravel-valet