-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #5 from pfrlv/main
chore: update readme
- Loading branch information
Showing
1 changed file
with
57 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,24 +1,67 @@ | ||
<a href="https://whiterussian.studio/"> | ||
<img src="https://whiterussian.studio/assets/wrs.png" alt="White Russian Studio" width="96"> | ||
<img src="https://whiterussian.studio/assets/wrs.png" alt="White Russian Studio" width="96"> | ||
</a> | ||
|
||
# KAT Kit | ||
|
||
Starter Kit with Kirby CMS | ||
=============================================== | ||
Kirby CMS, Alpine and Tailwind starter kit for your next project. | ||
Works with the built-in PHP server. No need to install Valet/Vagrant/MAMP or other tools that complicate the development workflow. | ||
|
||
Quick start of the project with [Kirby CMS](https://getkirby.com/), [Vite](https://vitejs.dev/), and [TailwindCSS](https://tailwindcss.com/) from [White Russian Studio](https://whiterussian.studio/) | ||
## Tools | ||
[Vite](https://vitejs.dev/) — for blazing fast frontend development (with live reloading) | ||
[Kirby CMS](https://getkirby.com/) — simple but powerful flat-file CMS | ||
[Alpine.js](https://alpinejs.dev/) — lightweight JavaScript framework for extending markup behaviour | ||
[Tailwind CSS](https://tailwindcss.com/) — the most popular utility-first CSS framework | ||
|
||
## Features | ||
Features [public folder structure](https://getkirby.com/docs/guide/configuration#custom-folder-setup) and `media` folder aliasing, extra ["SEO" and "Code injection"](./www/app/blueprints/tabs) tabs. Includes a fully configured HTML [`<head>`](www/app/snippets/site). | ||
|
||
- [Vite](https://vitejs.dev/) - build tool | ||
- [TailwindCSS](https://tailwindcss.com/) - CSS framework | ||
|
||
## Installation and Usage | ||
## Installation | ||
> ℹ︎ For the project to work correctly, you need to install and configure [Composer](https://getcomposer.org/download/) (PHP package manager), [Node.js](https://nodejs.org/en/) (>= 12.0.0), and meet [Kirby CMS requirements](https://getkirby.com/docs/guide/quickstart#requirements). | ||
1. `npm install` to install Node.js dependencies | ||
2. `npm run setup` to install Composer dependencies | ||
3. `cd www && valet link && cd ..` to set up development environment (example with [Laravel Valet](https://laravel.com/docs/8.x/valet)) | ||
4. `npm run dev` (or `npm run build` for use in production) | ||
Install JavaScript dependencies and Kirby CMS: | ||
|
||
To update Composer dependencies: | ||
`cd www && composer update && cd ..` | ||
```bash | ||
npm install | ||
npm run setup | ||
``` | ||
|
||
|
||
## Usage | ||
### Development | ||
|
||
Start both built-in and Vite dev servers: | ||
|
||
```bash | ||
npm run dev | ||
``` | ||
|
||
and open `localhost:8080` in the browser. | ||
|
||
### Build | ||
|
||
To build the project run: | ||
|
||
```bash | ||
npm run build | ||
``` | ||
|
||
### Preview | ||
|
||
To preview the built project run: | ||
|
||
```bash | ||
npm run build | ||
npm run kirby | ||
``` | ||
|
||
The preview will be available at `localhost:8080`. | ||
|
||
### Production | ||
|
||
After completing the build step, copy content from the `www` folder to a web server and set `public` as the root directory. | ||
|
||
--- | ||
|
||
|
||
White Russian Studio, 2021 |