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:
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.
First of all, install the dependencies to run this boilerplate.
# 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.
├── 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.
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.
gulp
: run all tasks and initialize watch for changes and a servergulp js
: execute js filesgulp jade
: compile jade filesgulp css
: compile stylus filesgulp images
: compress image filesgulp browser-sync
: inicialize a servergulp watch
: call for watch filesgulp pages
: deploy files to gh-pagesgulp deploy
: run all tasks and deploy files to gh-pages
Thanks to @Diessicode for the awesome idea to put this logo.
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.