Skip to content

sionnnn/fink

Repository files navigation

#fink

proposed development boilerplate / standards implementation

###usage

install ruby http://rubyinstaller.org/downloads/

gem install sass
npm clean cache

npm install
grunt

##grunt

###included dependencies

"devDependencies": {
    "grunt": "~0.4.1",
    "load-grunt-config": "^0.17.1",
    "grunt-contrib-copy": "^0.8.0",
        
    "grunt-contrib-watch": "~0.3.1",
    "grunt-contrib-connect": "~0.2.0",

    "grunt-jsdoc":"~0.6.7",

    "grunt-browserify": "^3.8.0",
    "grunt-babel": "^5.0.1",
    "grunt-typescript": "~0.6.2",
    "babelify": "^6.1.0",
    "tsify": "^0.11.2",

    "grunt-jscs":"~1.8.0",
    "grunt-eslint":"~16.0.0",

    "grunt-sass": "~1.0.0",
    "grunt-styleguide": "~0.2.17"
}

###TBD - grunt

#####images

#####responsive images

#####image min

#####css

#####js

#####sprites icons fonts

#####assets

#####ops performance

#####tasks

##js

###compiler

modular js using es6/esnext pattern airbnb styleguide

compile with either babeljs (greater ES6 support) or typescript (strongly typed, angular2.0) currently only compiles to commonJS, jQuery is imported via npm for babel, src/js/lib/jquery.d.ts for typescript

set in Gruntfile.js

data = {
    es6:'babel'
}

further info es compatibility tables

###code checker/linter

grunt JSCS and ESLint

ide plugins available for sublime/visual studio

###docs

./docs/jsdoc

guide JSDoc

####TBD - JS

##CSS

styleguides guardian / airbnb

###docs

./docs/styleguide

guide KSS

####TBD - CSS

##HTML

basic boilerplate included

./public/index.html

####TBD - HTML

  • templating ie stencil
  • icons / fonts (see grunt dependancies tbd)
  • shims/shivs/fallbacks/boilerplates polyfills
  • markup guidelines - accessibility wai-aria aria design patterns

##trello

*set up trello board for module dev???

About

boilerplate

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages