diverently/anotherkit

Another kirby project template

v1.10.2 2023-03-06 22:43 UTC

Requires

• php: ^8.1
• getkirby/cms: ^3.9

MIT

• Robert Cordes

• cms
• kirby
• starterkit

README

This is a starterkit for Kirby. It sets you up with Kirby 3.5+, TailwindCSS 2.0+ and AlpineJS.

Installation & setup

1. Start your new project with the following command:

   composer create-project diverently/anotherkit yourprojectname
   

   A new folder yourprojectname will be created with Kirby already setup.:

2. Next, cd into the newly created folder and run the following command:

   php ./configure.php
   

   This will run a script that will replace all placeholders throughout all the files.

3. After everything is installed, you can run npm start and start coding. 🎉

You can follow the Tailwind Docs for setting up your project specific configuration.

Change package.json

This starterkit includes the semantic-release package. To use it, you should change the repository in package.json. If you don't want to automatically version your repo, just remove the package by running npm uninstall semantic-release last-release-git and remove the release entry in package.json.

Semantic versioning

This starterkit uses semantic-release to automatically tag your commits. Here is an example of the release type that will be done based on a commit message (taken from their Readme):

semantic-release uses Angular Commit Message Conventions, so the type can be one of the following:

• build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
• ci: Changes to our CI configuration files and scripts (example scopes: Circle, BrowserStack, SauceLabs)
• docs: Documentation only changes
• feat: A new feature
• fix: A bug fix
• perf: A code change that improves performance
• refactor: A code change that neither fixes a bug nor adds a feature
• test: Adding missing tests or correcting existing tests
• chore: Changes that affect external dependencies for example