This repository is a fork of the official Craft CMS starter project, acting as a bootstrap template. If you've not used Craft before, I would recommend using the official repository, as this repo is quite opinionated on several structural decisions.
You will need composer to follow these instructions.
-
Configure an SQL database for the site to connect to.
-
Create the project. This will take a few minutes while it pulls down all the dependencies it requires:
composer create-project -n punchbuggy/craft <path>
Replace
<path>
with the path to the project folder, or.
if you would like to use the current folder. -
Configure the site to connect to the DB set up in step 1. You can do this by visiting
/admin
in a web browser, or running./craft setup
in your terminal. -
Hydrate the rest of the system with the following commands:
./craft migrate ./craft schematic/import --force
Original README:
Craft is a flexible and scalable CMS for creating bespoke digital experiences on the web and beyond.
It features:
- An intuitive Control Panel for administration tasks and content creation.
- A clean-slate approach to content modeling and front-end development.
- A built-in Plugin Store with hundreds of free and commercial plugins.
- A robust framework for module and plugin development.
Learn more about it at craftcms.com.
Craft is written in PHP (7+), and built on the Yii 2 framework. It can connect to MySQL (5.5+) and PostgreSQL (9.5+) for content storage.
See the following documentation pages for help installing Craft 3:
- Documentation – Everything from usage instructions to plugin guides.
- Class Reference – Full API and class reference for plugin and module developers.
- Demo site – Quickly launch a personalized demo of a Craft site.
- Craft Slack – Join one of the most friendly and helpful Slack groups around.
- Craft Commerce – First-party e-commerce platform for Craft.
- CraftQuest – Unlimited access to Craft training (and more) from Mijingo.
- Envato Tuts+ – Video courses.
- nystudio107 Blog – Articles about Craft and modern web development.
- Craft Link List – Bimonthly newsletter about the Craft ecosystem.
- Craft CMS Stack Exchange – Community-run Q&A for Craft developers.