Compare commits
2 commits
93939ff054
...
65364c5fb5
Author | SHA1 | Date | |
---|---|---|---|
65364c5fb5 | |||
916266b356 |
2 changed files with 37 additions and 31 deletions
54
README.md
54
README.md
|
@ -1,36 +1,42 @@
|
|||
<img src="http://getkirby.com/assets/images/github/plainkit.jpg" width="300">
|
||||
# Kirby MOIN! Starterkit
|
||||
|
||||
**Kirby: the CMS that adapts to any project, loved by developers and editors alike.**
|
||||
The Plainkit is a minimal Kirby setup with the basics you need to start a project from scratch. It is the ideal choice if you are already familiar with Kirby and want to start step-by-step.
|
||||
This startkit is based on the plainkit, but comes with the following adjustments:
|
||||
|
||||
You can learn more about Kirby at [getkirby.com](https://getkirby.com).
|
||||
- Custom folder structure with the document root in the `public` folder
|
||||
- Tailwind CSS
|
||||
- Webpack with [Stimulus](https://stimulus.hotwired.dev) and [Turbo](https://turbo.hotwired.dev)
|
||||
- Kirby CLI Command `serve`
|
||||
- Plugin that adds "Cache Busting" for JS and CSS files
|
||||
|
||||
### Try Kirby for free
|
||||
The `serve` command is inspired by the `symfony serve` command.
|
||||
|
||||
You can try Kirby and the Plainkit on your local machine or on a test server as long as you need to make sure it is the right tool for your next project. … and when you’re convinced, [buy your license](https://getkirby.com/buy).
|
||||
## Requirements
|
||||
|
||||
### Get going
|
||||
- nodejs/npm
|
||||
- php8.1+
|
||||
- [Kirby CLI](https://github.com/getkirby/cli)
|
||||
- composer
|
||||
|
||||
Read our guide on [how to get started with Kirby](https://getkirby.com/docs/guide/quickstart).
|
||||
## Install
|
||||
|
||||
You can [download the latest version](https://github.com/getkirby/plainkit/archive/main.zip) of the Plainkit.
|
||||
If you are familiar with Git, you can clone Kirby's Plainkit repository from Github.
|
||||
```bash
|
||||
composer install
|
||||
npm install
|
||||
```
|
||||
|
||||
git clone https://github.com/getkirby/plainkit.git
|
||||
## Start local environment
|
||||
|
||||
## What's Kirby?
|
||||
There is a command extension `serve` for the Kirby CLI. This will spawn a PHP Development
|
||||
Server, Tailwind CSS and a Webpack watcher.
|
||||
|
||||
- **[getkirby.com](https://getkirby.com)** – Get to know the CMS.
|
||||
- **[Try it](https://getkirby.com/try)** – Take a test ride with our online demo. Or download one of our kits to get started.
|
||||
- **[Documentation](https://getkirby.com/docs/guide)** – Read the official guide, reference and cookbook recipes.
|
||||
- **[Issues](https://github.com/getkirby/kirby/issues)** – Report bugs and other problems.
|
||||
- **[Feedback](https://feedback.getkirby.com)** – You have an idea for Kirby? Share it.
|
||||
- **[Forum](https://forum.getkirby.com)** – Whenever you get stuck, don't hesitate to reach out for questions and support.
|
||||
- **[Discord](https://chat.getkirby.com)** – Hang out and meet the community.
|
||||
- **[Mastodon](https://mastodon.social/@getkirby)** – Spread the word.
|
||||
- **[Bluesky](https://bsky.app/profile/getkirby.com)** – Spread the word.
|
||||
```bash
|
||||
kirby serve
|
||||
```
|
||||
|
||||
---
|
||||
## Production ready bundle
|
||||
|
||||
© 2009 Bastian Allgeier
|
||||
[getkirby.com](https://getkirby.com) · [License agreement](https://getkirby.com/license)
|
||||
Run the following command. This will build the css and js into the public folder.
|
||||
|
||||
```bash
|
||||
npm run build
|
||||
```
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name": "deichrakete/kirby-moin",
|
||||
"description": "Kirby starterkit with a custom folder structure and Tailwind CSS",
|
||||
"description": "Kirby starterkit with a custom folder structure, Tailwind CSS and Webpack with Stimulus and Turbo",
|
||||
"type": "project",
|
||||
"keywords": [
|
||||
"kirby",
|
||||
|
@ -13,14 +13,14 @@
|
|||
"name": "Bastian Allgeier",
|
||||
"email": "bastian@getkirby.com",
|
||||
"homepage": "https://getkirby.com"
|
||||
},
|
||||
{
|
||||
"name": "Stephan Plöhn",
|
||||
"email": "ploehn@deichrakete.com",
|
||||
"homepage": "https://deichrakete.com"
|
||||
}
|
||||
],
|
||||
"homepage": "https://getkirby.com",
|
||||
"support": {
|
||||
"email": "support@getkirby.com",
|
||||
"forum": "https://forum.getkirby.com",
|
||||
"source": "https://github.com/getkirby/plainkit"
|
||||
},
|
||||
"homepage": "https://deichrakete.space/deichrakete/kirby-moin",
|
||||
"require": {
|
||||
"php": "~8.1.0 || ~8.2.0 || ~8.3.0 || ~8.4.0",
|
||||
"getkirby/cms": "^5.0",
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue