https://github.com/terryupton/boilerplate-craft

A starting boilerplate for Craft Projects
https://github.com/terryupton/boilerplate-craft

boilerplate-craft craft laravel-mix tailwind-css twig

Last synced: about 1 month ago
JSON representation

A starting boilerplate for Craft Projects

• Host: GitHub
• URL: https://github.com/terryupton/boilerplate-craft
• Owner: terryupton
• License: mit
• Created: 2019-01-03T12:54:45.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2021-05-05T14:58:49.000Z (over 3 years ago)
• Last Synced: 2024-11-30T20:52:07.105Z (about 1 month ago)
• Topics: boilerplate-craft, craft, laravel-mix, tailwind-css, twig
• Language: Twig
• Size: 348 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Amasci Craft 3 Boilerplate with Tailwind CSS

A starting boilerplate for [Craft 3](https://craftcms.com/) projects using [Laravel Mix](https://laravel-mix.com/), [Tailwind CSS](https://tailwindcss.com/)

## Installation

1.  To create a new project, run `composer create-project terryupton/boilerplate-craft `, substituting  with the path where Composer should create the project.

2. Update a .env file adding the database connections and other settings

3. Run ./craft setup and follow the instructions

4. Refer to new `READdME.md` file for further instructions

## Content Management System (CMS)

- [Craft CMS](https://craftcms.com/)

- [Craft CMS 3.x documentation](https://docs.craftcms.com/v3/)

## Front-end

### Build Tools

- [Laravel Mix](https://github.com/JeffreyWay/laravel-mix)

### CSS

- [Tailwind CSS](https://tailwindcss.com/)

- [Tailwind UI](https://tailwindui.com/)

### JavaScript

- [Alpine JS](https://github.com/alpinejs/alpine)

- [lazySizes](https://afarkas.github.io/lazysizes/index.html)

- [Vue.js](https://vuejs.org/)

## TODO:

- Create proper Readme file and instructions.

- Add default files for composer, package, readme - see this example 

- Add Vue and Apline to package.default once created.

- Create better boilerplate template architecture.  

- Update `proejct.yaml` to add 1.0.0 schema versions for plugins.

- Update `proejct.yaml` to fix terms block and redactor field.

- Setup Humans.txt defaults in SeoMatic php settings files.

- Add fallback  tag into `head.twig` if SEOmatic fails.

- Add fallback meta tags into `head.twig` if SEOmatic fails.

- Convert Classes in components to arrays

- Convert Email QueryString to an Array (subject and body)

- Set button.twig component to switch between button and a href

- Set and test button.twig to use classes as an array and then apply this approach to other components.

## License

The MIT License (MIT). Please see [License file](./LICENSE.md) for more information.