README

This is a boilerplate for a craft install with a few plugins already installed, custom file structure, and a few pages with nav and a footer.

Usage

Firstly you need to create a database on your localhost.

To set up the boilerplate, you can use composer:

composer create-project fortytwo-studio/craft-cms-boilerplate [path]

Alternatively you can:

Clone the repo
Run composer install
- The post-install-cmd hook will run the setup, db import, npm install and finally removes the post-install-cmd scripts

Gulp

Gulp is utilised in the project to watch and build sass and js. Therefore you will need to have gulp-cli installed to rebuild files. You can install it with node - npm install --global gulp-cli. After that, just use gulp in the terminal to turn on the file watchers.

Plugins installed

Bootstrap

Bootstrap is installed as a node module and is imported in ./public/css/style.scss

JQuery

JQuery is installed as a node module and is imported an initialized in ./public/js.main.js

fortytwo-studio / craft-cms-boilerplate

Maintainers

Details