README

Craft 3 Boilerplate

A scaffolding package to help you hit the ground running with your next Craft CMS project.

What's included?

Craft CMS 3
Tailwind CSS
Laravel Mix
A sensible directory structure
Commonly used Craft CMS plugins:
- Asset Rev
- Imager
- Minify
- Redactor
- Sentry
- SEOmatic

Getting Started

Once you're happy that your server/machine meets Craft's requirements, you can start your new project by running the following command in your terminal:

composer create-project clubstudioltd/craft PATH

This will clone a copy of this repo to your machine and automatically install any Composer dependencies.

Next, head over to the Craft installation documentation and continue from Step 2.

Developing

After setting up Craft you're ready to start building your new project! Before getting started you'll want to pull in all frontend dependencies by running:

npm install

Once the dependencies have been installed, you can compile assets and start a watcher using:

npm run watch

That's it! Happy coding! 🎉

About Craft CMS

Craft is a content-first CMS that aims to make life enjoyable for developers and content managers alike. It is optimized for bespoke web and application development, offering developers a clean slate to build out exactly what they want, rather than wrestling with a theme.

Learn more about Craft at craftcms.com.

Resources

Documentation – Read the official docs.
Guides – Follow along with the official guides.
#craftcms – See the latest tweets about Craft.
Discord – Meet the community.
Stack Exchange – Get help and help others.
CraftQuest – Watch unlimited video lessons and courses.
Craft Link List – Stay in-the-know.

clubstudioltd / craft

Maintainers

Details