willianjusten / Fast Nunjucks

A simple boilerplate to create projects with Nunjucks, Stylus, Gulp, Browser-sync and more.

Maybe you want to read about them:

• GulpJS
• Nunjucks
• Stylus
• Browser-sync

For grid system I use Jeet with some help from Kouto Swiss for animations, reset and a lot of great mixins. And for responsive utilities, Rupture is awesome =)

Getting Started

Installation

First of all, install the dependencies to run this boilerplate.

• NodeJS
• GulpJS

# Clone this repository
$ git clone git://github.com/willianjusten/Fast-nunjucks.git new_project
$ cd new_project

# install dependencies
$ npm install

With the commands above, you have everything to start.

Folders and Files

new_project -
    /build -
        /css
            main.css
        /img
        /js
            main.js
    /src -
        /img
        /js
        /styl
        /templates
        .editorconfig
        .gitignore
        Gulpfile.js
        package.json
        Readme.md

Tasks

• gulp: Initialize watch for changes and a server(localhost:8080)
• gulp js: execute js files
• gulp nunjucks: compile nunjucks templates
• gulp stylus: compile stylus files
• gulp imagemin:compress image files
• gulp watch: call for watch files
• gulp -p: minify all files for production

License

This boilerplate is free and open source software, distributed under the The MIT License. So feel free to use this to create your site without linking back to me or using a disclaimer.

If you’d like to give me credit somewhere on your blog or tweet a shout out to @willian_justen, that would be pretty sweet.