node package manager

frank-styleguide

FRANK.NET Style Guide

Built with Grunt

Requirements

Ensure that the following is installed on your computer:

  1. Git
  2. Node.js

Getting Started

  1. Clone the repository: git clone git@github.com:we-are-next/frank-styleguide.git
  2. Change to the directory you cloned the repository into: e.g. cd frank-styleguide
  3. Install the required dependencies: npm install
  4. Start a local server: npm start

Features

  • Breakpoints, Colors, Fonts
    • less/generic/variables.less
  • Clearfix, Colors, Display, Embeds, Text Utilities
    • less/base/utilities.less
  • Transforms, Transitions
    • less/generic/mixins.less

Components

Polyfills

The following scripts are included for IE8 and below:

Linting and Validation

  1. HTML: grunt validation:build
  2. CSS: grunt csslint:build
  3. JavaScript: grunt eslint

Deploying

  1. Update the FTP server credentials in the .ftppass file
  2. Update the FTP deployment paths for the ftp-deploy task in Gruntfile.js
  3. Run the task: grunt deploy