Skip to content

Commit 3e85a3e

Browse files
committed
2025 edition
- Upgrade kirby to 5.0.0 - Upgrade composer dependencies - Remove yarn as a package manger - Use corepack and pnpm - Switch from Sass to plain CSS - Fix some inital bugs - Add VS Code startup script
1 parent af886e9 commit 3e85a3e

32 files changed

+3341
-1943
lines changed

.release-it.json

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"git": {
3+
"commitMessage": "chore: release v${version}",
4+
"tagAnnotation": "Version v${version}"
5+
},
6+
"github": {
7+
"release": true
8+
},
9+
"npm": {
10+
"publish": false
11+
}
12+
}

README.md

Lines changed: 44 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,39 @@ This Starterkit will open the Website and it's Panel in development mode, will l
66

77
## Prerequisites
88

9-
In order to work with this Repository, please [install Node](https://nodejs.org/en/download/) and [Yarn](https://yarnpkg.com/), if not happened before. Make sure, both is available.
9+
Kirby is a file-based CMS based on PHP. Please make sure your environment meets the [Kirby requirements](https://getkirby.com/docs/guide/quickstart#requirements).
10+
11+
For the frontend development, this package requires [Node.js](https://nodejs.org/en/download/), [corepack](https://github.com/nodejs/corepack) and [Composer](https://getcomposer.org/download/) to be installed. Corepack is used to install the locked package manager (pnpm), where Composer is used to manage PHP dependencies.
12+
13+
<details>
14+
<summary>Install Node.js and corepack</summary>
15+
16+
Follow the official installation guide of [Node.js](https://nodejs.org/en/download/) and be sure to choose the LTS version. If your Node.js is higher than the LTS version, you need to "downgrade" it.
17+
18+
Corepack is shipped with Node.js until version 25 and is enabled by default.
19+
20+
</details>
21+
22+
<details>
23+
<summary>Uninstall your global Package Managers</summary>
24+
25+
You need to uninstall your global Yarn and pnpm binaries to avoid conflicts with corepack.
1026

1127
```shell
12-
$ npm install -g yarn
13-
$ npm -v && yarn -v
28+
npm uninstall -g yarn pnpm
1429
```
1530

31+
</details>
32+
1633
## Installation
1734

1835
If your Computer is ready-to-go, clone this Repository and install it's dependencies.
1936

2037
```shell
21-
$ git clone git@github.com:macx/kirby-vite-starterkit.git my-website
22-
$ cd my-website
23-
$ composer install
24-
$ yarn install
38+
git clone git@github.com:macx/kirby-vite-starterkit.git my-new-project
39+
cd my-new-project
40+
composer install
41+
corepack enable
2542
```
2643

2744
To get feature updates from this starterkit, add a remote host entry and pull a new version. Be sure to commit your changes before. If you just want to update Kirby, [do it on your own](https://getkirby.com/docs/cookbook/setup/composer#updating-kirby).
@@ -33,30 +50,34 @@ $ git pull updates
3350

3451
## Development
3552

36-
<!-- prettier-ignore -->
37-
| Folder | What's in it? |
38-
| :-- | :-- |
39-
| `/content` | The [content](https://getkirby.com/docs/guide/tour#where-the-content-lives) of your website. |
40-
| `/src` | All your assets for the Vite bundling. `app.js` and `app.scss` are your main styles and script. |
41-
| `/src/assets` | Folder for your global Fonts and Images. |
42-
| `/src/templates` | Optionally, every page can contain it's own styles `index.scss` and script `index.js`. |
43-
| `/site` | Project folder for Kirbys [Config](https://getkirby.com/docs/guide/configuration), [Blueprints](https://getkirby.com/docs/guide/blueprints/introduction), [Plugins](https://getkirby.com/docs/guide/plugins/plugin-basics), [Snippets](https://getkirby.com/docs/guide/templates/snippets) and [Templates](https://getkirby.com/docs/guide/templates/basics). |
44-
| `/public` | The [Public folder](https://getkirby.com/docs/guide/configuration#custom-folder-setup__public-folder-setup) is your document root of your website, including the bundled assets from Vite. |
45-
46-
### Startits
53+
To start the development server, run:
4754

4855
```sh
49-
$ yarn dev
56+
pnpm run dev
5057
```
5158

52-
```sh
53-
$ yarn build
54-
```
59+
You can also run the following commands:
5560

5661
```sh
57-
$ yarn preview
62+
# Build the project
63+
pnpm run build
64+
65+
# Preview the built project
66+
pnpm run preview
5867
```
5968

69+
#### Folder Structure
70+
71+
<!-- prettier-ignore -->
72+
| Folder | What's in it? |
73+
| :-- | :-- |
74+
| `/content` | The [content](https://getkirby.com/docs/guide/tour#where-the-content-lives) of your website. |
75+
| `/src` | All your assets for the Vite bundling. `main.js` and `main.css` are your main styles and script. |
76+
| `/src/assets` | Folder for your global Fonts and Images. |
77+
| `/src/templates` | Optionally, every page can contain it's own styles `index.css` and script `index.js`. |
78+
| `/site` | Project folder for Kirbys [Config](https://getkirby.com/docs/guide/configuration), [Blueprints](https://getkirby.com/docs/guide/blueprints/introduction), [Plugins](https://getkirby.com/docs/guide/plugins/plugin-basics), [Snippets](https://getkirby.com/docs/guide/templates/snippets) and [Templates](https://getkirby.com/docs/guide/templates/basics). |
79+
| `/public` | The [Public folder](https://getkirby.com/docs/guide/configuration#custom-folder-setup__public-folder-setup) is your document root of your website, including the bundled assets from Vite. |
80+
6081
## Thanks to
6182

6283
This Starterkit was heavely inspired by the [Kirby Vite Multi Page Kit](https://github.com/arnoson/kirby-vite-multi-page-kit) from @arnoson.

composer.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
"type": "project",
55
"license": "MIT",
66
"require": {
7-
"php": ">=7.4.0 <8.3.0",
8-
"getkirby/cms": "^3.9",
9-
"arnoson/kirby-vite": "^4.0"
7+
"php": ">=8.3.0",
8+
"getkirby/cms": "^5.0",
9+
"arnoson/kirby-vite": "^5.6.1"
1010
},
1111
"config": {
1212
"optimize-autoloader": true,

0 commit comments

Comments
 (0)