/html-starter-bs4-webpack

HTML starter template with front-end development kit for building web apps and sites.

Primary LanguageCSSMIT LicenseMIT

HTML Starter

This boilerplate with Webpack based setup helps you build web apps and sites much faster. Kick-start your project with popular development workflow.

Features

  • Webpack 4 - module bundler (automatically concatenate files, write CSS with Sass, check JS for errors, optimize images...)
  • Bootstrap 4 - the most popular HTML, CSS and JS framework
  • HTML5 Boilerplate - the web’s most popular front-end template
  • Sass - CSS preprocessor
  • Font Awesome 5 - the web's most popular vector icons and social logos
  • Autoprefixer - plugin to parse CSS and add vendor prefixes
  • Babel - toolchain to convert ES6+ code into a backwards compatible
  • ESLint - linting utility for JavaScript
  • webpack-dev-server - live reloading (browser update after changes)
  • Google Fonts - libre licensed fonts

Bootstrap 4 is dependent on:

  • jQuery - JavaScript library
  • Popper - tooltips and popovers library

Theme development

Node.js is the only required dependency to work with HTML Starter.

Installation

  1. Install Node.js (installation depends on your system). After finishing, you will be able to check the version number using node -v and npm -v commands (npm is distributed with Node.js).
  2. It is recommended to install the latest version of Yarn.
  3. Clone the repo using git clone https://github.com/cichy380/html-starter-bs4-webpack.git or download HTML Starter.
  4. Open folder html-starter-bs4-webpack (command: cd html-starter-bs4-webpack) and install necessary dependencies of Starter via command: yarn (recommended) or npm install.

You now have all the necessary dependencies to run the build process. HTML Starter uses Webpack as its build system.

Build commands

  • yarn start or npm run start - compile assets when file changes are made, start webpack-dev-server session
  • yarn build or npm run build - compile and optimize (the files in your assets directory) for production

License

Code released under the MIT license.