An open API service indexing awesome lists of open source software.

https://github.com/ackstudio/craft

CraftCMS starter kit providing a solid, opinionated foundation for launching any new Craft CMS project.
https://github.com/ackstudio/craft

craftcms ddev sprig tailwindcss vite

Last synced: about 1 year ago
JSON representation

CraftCMS starter kit providing a solid, opinionated foundation for launching any new Craft CMS project.

Awesome Lists containing this project

README

          

# Craft CMS 5 Boilerplate with Vite and Tailwind

Welcome to the Craft CMS 5 Boilerplate by [ACK STUDIO](https://ackstudio.com). This starter kit is specifically crafted for in-house use at ACK STUDIO, providing a solid, opinionated foundation for launching any new Craft CMS project.

## Tech Stack

- [Craft CMS 5.x](https://craftcms.com) - Powerful Content Management System
- [DDEV](https://ddev.com) - Docker-powered Local Development Environment
- [Vite 5.x](https://vitejs.dev) - Fast Front-end Build Tool with Hot Module Replacement (HMR)
- [Tailwind CSS 4.x](https://tailwindcss.com) - Utility-first CSS Framework for efficient UI development

## System Requirements

- [DDEV](https://ddev.com) - Ensure DDEV is installed for smooth local development

## Key Features

- **Template System**
- Pre-structured layout templates with base layouts, global headers, footers, and page templates
- Custom error pages for 404, maintenance, and generic errors

- **Configuration Management**
- Pre-configured settings for Craft CMS and essential plugins

- **Optimized Build Process**
- Hot Module Replacement (HMR) for real-time front-end updates
- Automatic minification and purging of CSS and JS for optimized performance

## Included Plugins

### Craft CMS Plugins

- **Vite** - Integrated front-end build tool for streamlined development
- **Sprig** - Enables reactive, interactive components within Twig templates

## Installation

1. Create a project directory and move into it:

```bash
mkdir my-craft-project
cd my-craft-project/
```

2. Create DDEV configuration files:

```bash
ddev config --project-type=craftcms --docroot=web
```

3. Start DDEV:

Firstly, edit .ddev/config.yaml and change the name to your project name.

```bash
ddev start
ddev exec npm install
ddev composer install
ddev exec php craft install
```

## Authors
- [ACK STUDIO](https://ackstudio.com)