Skip to content

danielbeutner/whiplash

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

85 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

whiplash Build Status

The power of riot and browserify within a gulp starter-kit.

No bullshit bingo...

  • Elements, modules and pattern
  • Automated loading of all tags including precompile
  • SCSS support
  • Browserify & Vorlon support
  • Browser-Sync support
  • Organized gulp tasks
  • Plain HTML and JavaScript
  • Icon generator (Many thanks to cognitom, gulp-sketch and gulp-iconfont)

Getting started

Dependencies

You need gulp installed globally, so if you don't have it, install it:

npm install --global gulp

Installation

Easy installation with:

npm install

Build

Build everything you need:

gulp build

Development

Start hacking:

gulp or gulp watch

Usage

In src there are all files you need:

src
|-assets/           // All assets
|-css/              // SCSS files for styling
|-html/             // Your initial html file
|-icons/            // Raw icon files and templates
|-js/               // JavaScript stuff
|-tags/             // Tags with .tag and .scss files
  |-elements/       // Elements - the smallest component
  |-modules/        // Modules - component with more than one element
  |-pattern/        // Pattern - component with more than one module and elements
  |-pages/          // Pages - complete pages with content and functionality
  |-templates/      // Templates - abstract of a page, only structure
  |-app.scss        // Global style for <app> tag
  |-app.tag         // The initial tag for you app

Now you can add atoms, molecules, organisms, pages and templates to your app. It will automatically merge into the app directory.

This could be look like this:

app
|-assets/
|-app.css
|-app.css.map
|-app.html
|-app.js

That's it.

About

The power of riot and browserify within a gulp starter-kit.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published