gobrasil/qualy

A simple boilerplate with ES6, Gulp, Jade, Stylus and Browsersync.

This projects uses ES6, Jade, Stylus, Gulp and Browsersync. The main objective of this boilerplate is to ensure Quality to our code with Code Standards and Hooks to prevent messy codes to be committed or pushed.

Maybe you want to read about them:

• GulpJS
• Jade
• Stylus
• Browsersync

For grid system uses Jeet with some help from Kouto Swiss for animations, reset and a lot of great mixins. Rupture for responsive utilities and uses ITCSS to build the CSS Architecture.

Getting Started

Installation

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

• NodeJS
• GulpJS

# Clone this repository
$ git clone [email protected]:Qualy-org/qualy.git
$ cd qualy

# install dependencies
$ npm install

With the commands above, you have everything to start.

Folders and Files

├── README.md
├── build
│   ├── css
│   │   └── main.css
│   ├── img
│   │   └── eventos.jpg
│   ├── index.html
│   └── js
│       └── main.js
├── gulpfile.babel.js
├── package.json
└── src
    ├── img
    │   └── eventos.jpg
    ├── js
    │   ├── main.js
    ├── styl
    │   ├── _base.styl
    │   ├── _components.styl
    │   ├── _generic.styl
    │   ├── _objects.styl
    │   ├── _settings.styl
    │   ├── _tools.styl
    │   ├── _trumps.styl
    │   └── main.styl
    └── templates
        └── index.jade

Those folders and file will change during the project.

Code Standarts

This project uses JSCS with Airbnb presets and the .editorconfig is defined to have indent_size of 4 spaces.

This project also uses Husky to prevent commit and push messy and wrong code. Please, don't be stupid, fix all errors before commit and push =D

To help you, this project has a npm run fix command to fix all jscs errors.

Tasks

• gulp: run all tasks and initialize watch for changes and a server
• gulp js: execute js files
• gulp jade: compile jade files
• gulp css: compile stylus files
• gulp images: compress image files
• gulp browser-sync: inicialize a server
• gulp watch: call for watch files
• gulp pages: deploy files to gh-pages
• gulp deploy: run all tasks and deploy files to gh-pages

Thanks

Thanks to @Diessicode for the awesome idea to put this logo.

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.