Skip to content

oliverfindl/html-sass-babel-boilerplate

Repository files navigation

html-sass-babel-boilerplate

license paypal

Simple boilerplate for building web app with node-sass and @babel/cli.


Install

# Clone repository from GitHub to <directory>
$ git clone https://github.com/oliverfindl/html-sass-babel-boilerplate <directory>

# Switch to <directory>
$ cd <directory>

# Install all dependencies
$ npm install

# [optional] Check and update all dependencies
$ npm outdated
$ npm update

Usage

# Build and minify both resources
$ npm run build

# Build and minify main.js file
$ npm run build:js

# Watch for changes in main.js file
$ npm run watch:js

# Build and minify main.scss file
$ npm run build:css

# Watch for changes in main.scss file
$ npm run watch:css

# Lint main.js file
$ lint:js

# Fix main.js file
$ lint:js:fix

Structure

.                           # root
├── dist                    # directory for distributables
│   ├── css                 # directory for minified css files
│   └── js                  # directory for minified js files
├── src                     # directory for source code
│   ├── js                  # directory for js files
│   │   └── main.js         # main js file
│   └── scss                # directory for scss files
│       ├── functions.scss  # scss file for functions
│       ├── main.scss       # main scss file
│       └── variables.scss  # scss file for variables
├── index.html              # index file for web app
├── package.json            # npm configuration file
└── purgecss.config.js      # purgecss configuration file

License

MIT