red-boilerplate

RED Boilerplate ==========================================================================================

npm install red-boilerplate
4 downloads in the last month

RED Boilerplate

RED Interactive's boilerplate to initialize common projects.

Features

  • Modular hierarchy.
  • Auto-renaming of project variables.
  • Support for both Django-based and static-based projects.

Requirements

  • node 0.8.4+
    • brew update && brew upgrade node
  • npm 1.1.45+
    • npm update npm -g
  • grunt 0.3.11+
    • npm install grunt -g

How to use

Creating a project

Using the rbp NPM module

npm install rbp -g
rbp new project

Standalone

git clone https://github.com/ff0000/red-boilerplate.git
grunt start

Usage

Run grunt --help for a list of available tasks.

grunt start

Initialize the project. This is required before running any other task. The task will ask for:

  • Your project's title
  • Your project's namespace
  • A list of available plugins to install

grunt install

Install a plugin after project initialization. Use via grunt install:plugin

grunt build

Builds your project. Functionality varies based on installed plugins.

grunt watch

Watch your project for file changes. Functionality varies based on installed plugins.

Available plugins

  • Caboose - RED Interactive's internal SASS + Compass framework
  • JSHint - Lint your JavaScript with JSLint
  • RED Start - Easy creation of Django projects and applications based the layout used at RED Interactive Agency.
  • Rosy - An inheritable / extendable JavaScript framework.
  • Statix - Statix is a static website generator.
npm loves you