Skip to content

KhodorAmmar/static-html-boilerplate

 
 

Repository files navigation

Static HTML Boilerplate

The boilerplate is an opinionated folder structure to help you kick-start your html project. It includes the necessary build tools and configurations and is easily extendable.

Requirements

What's included

  • Bootstrap: Bootstrap's normalize, grid system, and utility classes are imported by default.
  • Webpack: With babel, allows you to use ES6 code and modules.
  • Handlebars: Build your html with partials.
  • SVG sprites: Add your icons in assets/icons and use them.
  • Server: Node.js code for easy, gzipped, and secure static website hosting.
  • BrowserSync: As a development server.
  • gulp: Used to build sass, build svgs, run handlebars, and copy files to public folder.

How to proceed

  1. Prepare a coffee
  2. Run: npm i to install the dependencies
  3. Run: gulp to build and watch
  4. Start coding!

Test

The boilerplate includes three necessary tests for your code:

  • a HTML5 validator (npm run w3js),
  • an accessibility reporter (npm run a11y),
  • and an eslint linter (airbnb) (npm run lint).

Deploy

You only need to deploy the server code and the dist folder.

Deploy on AWS EB

About

Start all your HTML here

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • CSS 55.1%
  • JavaScript 37.7%
  • HTML 7.2%