giologist/water

Water

A front-end boilerplate that just flows.

What is Water?

• Atomic Design - Atomic design methodology out-the-box, keeping you organized & ready-to-go.
• Automation - Using tools like Gulp and Sass in order to optimize your workflow, Water takes care of the little (but annoying) stuff.
• Living Styleguide - Water scans comments from your existing components and automagically creates (and updates) a style guide for you, using KSS StyleSheets.
• Twig Templating - Water uses Twig, the most reliable template engine.

Gulp Tasks

Here's the list of gulp tasks included:

• lint - Detect JS Errors
• sass - Compile & Concat Sass
• scripts - Minify & Concat JS
• twig - Compile Twig templates
• watch - Watch js, scss & twig files for changes and automatically refresh browser.
• styleguide-build - Compile & automatically create a styleguide
• styleguide-watch - Watch for all StyleGuide related changes
• styleguide - Runs both styleguide-build and styleguide-watch

Note: Running gulp alone, performs all of the above.

Installation

git clone [email protected]:giologist/Water
npm install
gulp

water's Issues

TWIG Task not rendering/parsing pages to ./dist

The twig task uses the subfolders in ./src/pages and puts them in ./dist

for example : ./src/pages/index/index.twig ist delivered to ./dist/index/index.html

this is a problem as this page doesn't have the correct path to the assets as it is one folder to deep.

either the pages should not have subfolders or the twig task should deliver the renderd pages dirctly to ./dist, so that the path to the assets are correct and the dev server shows something.