README

Migrated from https://gitlab.cwp.govt.nz/nguyer/cwp-gumby-theme

This project started as a straight substitution of bootstrap for gumby within the CWP code base, but can be used as the starting point for any silverstripe theme. CWP base templates have been updated to work with the gumby scss framework, and extra styles added where needed. Accessibility has being taken into account, but otherwise the theme uses the gumby defaults with minor tweaking to fit with cwp templates.

Compass and Sass compiling issues?

This branch has been updated to work with the latest Compass and Sass. If you are having issues with compiling, try the older version of this theme (2.6.3-oldcompass).

Purpose

This theme is intended as a starting point for development, rather than a theme to be used out of the box. For this reason, it has not been styled to look like the CWP default theme, and design modifications have been kept to a minimum. Hopefully this should mean you spend less time taking out design features you don't want, and have more time to spend on adding your own themes.

How to use

Either grab the git url, and clone into your themes directory or add it to your composer file [more info to come] git clone https://github.com/adrexia/silverstripe-gumby.git

It is intended that development be done on the Sass files, rather than editing the CSS directly. Each component has been split out into it's own file where possible.

If you have never used Gumby, Sass, or Compass before, this is a good place to start:

http://gumbyframework.com/docs/#!/

If you need more try:

When you have the theme and have renamed it to suit your project, open _settings.scss (sass/var/_setting.scss) and edit the theme name variable to match. This will update all scss links to point to your theme. Remember to run grunt watch in the theme folder to compile your scss.

Building

This theme now use grunt to compile css and javascript. You can remove this dependency, and link to the prebuilt css and js requirements directly. There is no magic, but tools such as grunt save a bit of time once set up. If you have not used grunt before, [start here] (http://mattbailey.io/a-beginners-guide-to-grunt/)

Once you have npm installed, run:

npm install

from within your theme directory (themes/your_theme) to install all dependencies. Then run

grunt watch

This will watch for changes in both your Sass and Javascript files, and compile them for you.

If you are using CWP, you should override the CWP BasePage.php function that includes scripts and css to prevent it trying to include unwanted files (or including them in the wrong order). To add extra dependencies, open Gruntfile.js and add them under concat : dist : src.

Browser support

Firefox, Chrome
IE8 and above
Android, iPhone, iPad

Screenshot

HomePage

MIT Open Source License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

adrexia / silverstripe-gumby-theme

Maintainers

Details