Business Services Printing WordPress theme

Repository for UCFCard.ucf.edu WordPress theme build, created by Mike Setzer, maintained by Business Services. This project includes a full setup of GruntJS and LESS for automation, and Jenkins for deployment.

Deployment

• The Dev branch is automatically deployed to the UCFCard Dev environment
• The Master branch is automatically deployed to the UCFCard QA environment
• Deployment to production is done manually via Jenkins using release versions

System Preparation

1. NodeJS - Use the installer.
2. GruntJS - $ npm install grunt grunt-cli (mac users may need sudo)
3. LESS - $ npm install -g less (mac users may need sudo)

Getting Started

1. If needed, install node and npm (Node Package Manager).

• If needed, install grunt with npm install grunt grunt-cli.
• Clone this repo with git clone https://github.com/UCF/BS-officeplus-theme or download the zip.
• In terminal, cd to the folder containing your project. Alternatively, you can type cd and drag the location of the folder into your terminal and hit enter (on Macs).
• In terminal, type npm install. If (and only if) npm install isn't working, try sudo npm install. This should install all dependencies.
• In terminal, enter grunt default.
• Your LESS files will be compiled and minified to lib/styles.css
• Keep grunt running while you're making changes. When you want to stop the gulp task, hit ctrl + C.

Local Installation

1. Clone this repo or download it into a directory of your choice.
2. $ cd into the directory and run $ npm install.
3. Run npm install grunt --save-dev

Usage

Development Mode

This will give you file watching, auto-rebuild, and CSS injection.

$ grunt default

WordPress modularization

WordPress theme files

• Reusable template parts, such as menus go to /template-parts
• Individual parts go to /templates

WordPress styletheme modifications are added to the partials folders

If you are modifying a plugin's CSS, eg. GravityForms, simply:

• Add a _gforms.scss file to partials
• Add the import to partials/_index.scss
• And head the _gforms.scss file with the appropriate selector

Deployment

• The Dev branch is automatically deployed to the UCFCard Dev environment
• The Master branch is automatically deployed to the UCFCard QA environment
• Deployment to production is done manually via Jenkins using release versions
• Be sure to update the style.css with the version on new releases.

Features

• Autoprefixer configuration
• SMACSS and Atomic Design-based folder structure
• px to em, px to rem and other useful functions.
• Mixins for inlining media queries.

• Useful CSS helper classes.
• Default print styles, performance optimized.
• "Delete-key friendly." Easy to strip out parts you don't need.

Dependencies

  "colors": "^1.1.2",
  "del": "^2.0.2",
  "gulp-autoprefixer": "^2.1.0",
  "gulp-rename": "^1.2.0",
  "gulp-sass": "^1.3.2",
  "gulp-sass-lint": "1.0.1",
  "gulp-sourcemaps": "^1.5.2",
  "sassdoc": "^2.1.15",
  "vinyl-paths": "^2.0.0"

Tasks

• default
• build
  • styles