anuarhdz/craft-goodkit

v1.1.1 2024-07-01 13:44 UTC

Requires

• craftcms/ckeditor: 4.1.0
• craftcms/cms: 5.2.4.1
• craftcms/query: ^3.1
• nystudio107/craft-closure: ^1.0
• nystudio107/craft-seomatic: 5.0.4
• nystudio107/craft-vite: 5.0.0
• studioespresso/craft-splashingimages: ^5.0
• verbb/hyper: 2.0.2
• verbb/navigation: 3.0.1
• vlucas/phpdotenv: ^5.4.0

Requires (Dev)

• craftcms/generator: ^2.0.0
• yiisoft/yii2-shell: ^2.0.3

MIT

README

This Craft CMS 5 starter kit is a modern front-end development workflow for Craft CMS that combines the latest front-end technologies and tools with best practices. It's designed to help you get up and running quickly and optimize your project for production.

Stack

• Craft CMS 5
• DDEV
• Vite
• Tailwind CSS
• Alpine
• Prettier

Getting Started

Prerequisites

In order to install and run this repository correctly, verify that you have installed:

• Docker. I recommend using OrbStack.
• DDEV. Check the installation documentation.
• VSCode and Dev Containers extension.

Installation from Scratch

1. Make sure that you have Docker and DDEV installed.

2. Run composer create-project anuarhdz/craft-goodkit ./YOUR/PROJECT/PATH --no-install to create a new Craft CMS Goodkit project. Replace YOUR/PROJECT/PATH with the path where you want to create the project.

3. Run ddev config --project-name=YOUR_PROJECT_NAME to configure the DDEV environment. Replace YOUR_PROJECT_NAME with the name of your project.

4. Navigate to the project directory and run ddev start. This will start the DDEV environment. If everything is configured correctly, you will see a message similar to the following:

Your project can be reached at https://YOUR_PROJECT_NAME.ddev.site https://127.0.0.1:XXXXX

1. Now you can run ddev code to open the project in VSCode.

If VSCode correctly starts the project inside a dev container and you can access the URL of your project, you have correctly configured the repository.