README.md

Requirements

Required GEM

$ gem install sass-globbing

Install Globally

$ npm install -g gulp $ npm install -g bower

Install Dependencies

$ npm install $ bower install --save

GENERAL INFO FOR PROJECT BELOW

###########################################################################################################################

Info & Link to Git repo

gitosis@git.plankdesign.com:name_of_repo_here (Link for Windows users) --- (Link for Mac / Linux users)

Backend documentation

Framework used (Laravel, Bold, CakePHP, …)

MySQL initial DB setup infos

Frontend documentation

README.md file (for project initial setup on local server folder)

Framework used: Plank boilerplate, based on Bootstrap

CMS (indicate any info on what CMS is used below)

Templates logic

Grid system (Susy, Bourbon, …)

Extra Dependencies list & info

Font service used (Typekit, Typography.com, …) and mention link vault.plankdesign.com login info for said account

Links to mockups and design on File Server

Necessary symlinks to add to project on local web server

URL to wireframes

URL to Style guide / Kitchen Sink

http://boilerplate.dev/kitchen-sink.php

Site URLs

Local boilerplate.dev

Staging/dev boilerplate.dev.plankdesign.com

Live boilerplate-plank.com (example)