Note: This is a work in progress and is likely to be modified frequently!

generator-ss-af

A Yeoman generator for SilverStripe CMS projects, including a basic Grunt workflow.

Getting Started

What is it

A Yeoman generator that scaffolds out a bare-bones SilverStripe site, including a basic Grunt workflow.

Requirements

1. Node

• Yeoman (this will also install Grunt and Bower)
• You'll need Apache, MySQL and PHP to be running (you could use MAMP or this guide if you're on OS X Yosemite)
• An empty MySQL database ready
• The local domain name of your site added to your /etc/hosts file, eg. 127.0.0.1 my-project.dev
• Composer

Installation

sudo npm install -g generator-ss-af

How to use it

Once you're satisfied your system meets the above requirements run the following command in an empty directory and answer the questions it asks you:

yo ss-af

Updating dependencies

If the yo task errors out, you may need to update node, npm, grunt, and some npm dependencies. The optimum node version is 4.5.0. Update to this version by running:

sudo npm install -g n
sudo n 4.5.0

Update the npm version:

sudo npm install -g npm

If the npm install task errors, you can try running it again as sudo, then try grunting.

sudo npm install
sudo grunt

Then visit the local domain you set up in your browser, eg. http://my-project.local, and you should see a very basic SilverStripe install.

Admin access

Admin URL: http://my-project/admin
Admin username: admin
Admin password: password

Directory structure

The generator scaffolds out a project with the following structure:

assets/
silverstripe-cache/
_ss_environment.php

# .gitignore and composer.json
# SilverStripe cms, framework, my-site etc.
themes/[my-project]/ # Theme assets and templates, Grunt workflow etc.
vendor/ # Composer packages

Sourced mostly from

https://github.com/gpmd/generator-silverstripe

by Matt Bailey

adapted by Tom Downard