Kuro Boilerplate

This project uses ES6, Webpack, Nunjucks, SASS, PostCSS, Gulp and Browsersync.

Maybe you want to read about them:

• Browsersync
• GulpJS
• Nunjucks
• PostCSS
• Sass
• Webpack

Installation

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

• NodeJS
• GulpJS

# Clone this repository
$ git clone git@github.com:julian-kuroiwa/kuro-boilerplate.git
$ cd kuro-boilerplate

# install gulp globally
$ npm install -g gulp

# install dependencies
$ npm install

With the commands above, you have everything to start.

├── README.md
├── dev/build
│   ├── css/
│   │   └── main.min.css
│   ├── images/
│   ├── scripts/
│   │   └── main.min.js
│   ├── index.html
├── gulpfile.babel.js
│   ├── config.json
│   ├── index.js
├── package.json
└── src
    ├── images/
    ├── js/
    │   └── main.js
    ├── sass
    │   └── main.scss
    └── views
    └── └── index.html

Those folders and file will change during the project.

Code Standards

This project uses eslint and .editorconfig is defined to have indent_size of 2 spaces.

This project also uses Husky to prevent commit and push messy and wrong code.

Tasks

• npm start: run all tasks and initialize watch for changes and a server
• npm run build: run all tasks and deploy files

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

License

This project is licensed under the MIT License - see the LICENSE.md file for details