WASA Boilerplate

A front-end boilerplate that's easy-to-use and ready-to-go.

• Requirements
• Installation
• Usage
  • NPM Scripts
    • TL;DR: start and watch
• Documentation
  • Scripts
    • Configuration
    • ES Linter
  • Styles
    • Configuration
    • SCSS Linter
  • Views
• Git naming convention

Requirements

• node-js >= 6.4.0

Installation

To automate the installation process, we recommend that you use the wasa-cli, a CLI tool that can initialize ready-to-go new projects based on this boilerplate in no time.

Otherwise, follow these instructions:

• npm install to install the dependencies.
• npm install -g commitizen to globally install Commitizen.

Usage

NPM Scripts

The boilerplate is powered by npm scripts. No need of Gulp or anything else, as we are using the CLI services of Babel, Node-Sass, Pug (etc.). You can run each script individually. For each type of asset, there are at least two scripts. One is used to build, the other to watch for changes. All scripts all listed below, but you can also find them in the "scripts" section of the ./package.json file.

• clean-build: remove the old build, and create the needed directories

• remove-build: remove build

• start: clean the build, build, watch and start server

• build: build the assets and the views

• build-task:babel: build the scripts

• build-task:pug: build the views

• build-task:node-sass: build the styles (scss)

• build-task:post-css: build the styles (css w/ autoprefixer)

• scripts:watch: watch the scripts

• views:watch: watch the views

• styles:build: build node-sass and post-css

• styles:watch: watch the styles

• browser-sync: start server

TL;DR: To start the server while watching the assets, run:

npm run start

Documentation

Scripts

Configuration

We are not using nodejs requires as it is not compatible with modern browsers. As a result, import/requires/exports are not allowed. Every JS code must be written inside of a single file, located in ./app/scripts/index.js

ES Linter

We are using the Airbnb JavaScript Style Guide. You can find the configuration file in ./.eslintrc. The linter is not passing through our code. Instead, we recommend that you use a package within your text editor:

• Sublime Text: SublimeLinter, SublimeLinter-contrib-eslint, and eslint (globally installed, npm install -g eslint).
• Atom: linter and linter-eslint.

Styles

Configuration

Every import is located in ./app/styles/index. They are separated into five categories:

• abstracts: configuration and helpers.
• base: basic files (reboot, grid etc.).
• components: speaks for itself (e.g. Button).
• layout: layout-related sections (e.g. Header).
• pages: page-specific styles (e.g. homepage).

SCSS Linter

We are using the Airbnb CSS / Sass Styleguide. You can find the configuration file in ./.scss-lint.yml. The linter is not passing through our code. Instead, we recommend that you use a package within your text editor:

• Sublime Text: SublimeLinter, SublimeLinter-contrib-scss-lint, ruby and scss_lint.
• Atom: linter and linter-scss-lint

Views

We are using PugJS to handle HTML content, a simple framework to quickly produce content.

Git naming convention

We are using Commitizen to automate our git messages. Simply add files to your commit and then run the command git cz. A prompt will appear and automate your process. By default, we are using the conventionnal-changelog convention (e.g. 'feat(boilerplate): init boilerplate'). It can be paired with standard-version to automate your changelogs and publishing process.