You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- 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
Copy file name to clipboardExpand all lines: README.md
+44-23Lines changed: 44 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,22 +6,39 @@ This Starterkit will open the Website and it's Panel in development mode, will l
6
6
7
7
## Prerequisites
8
8
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.
10
26
11
27
```shell
12
-
$ npm install -g yarn
13
-
$ npm -v && yarn -v
28
+
npm uninstall -g yarn pnpm
14
29
```
15
30
31
+
</details>
32
+
16
33
## Installation
17
34
18
35
If your Computer is ready-to-go, clone this Repository and install it's dependencies.
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
33
50
34
51
## Development
35
52
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:
47
54
48
55
```sh
49
-
$ yarn dev
56
+
pnpm run dev
50
57
```
51
58
52
-
```sh
53
-
$ yarn build
54
-
```
59
+
You can also run the following commands:
55
60
56
61
```sh
57
-
$ yarn preview
62
+
# Build the project
63
+
pnpm run build
64
+
65
+
# Preview the built project
66
+
pnpm run preview
58
67
```
59
68
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
+
60
81
## Thanks to
61
82
62
83
This Starterkit was heavely inspired by the [Kirby Vite Multi Page Kit](https://github.com/arnoson/kirby-vite-multi-page-kit) from @arnoson.
0 commit comments