Skip to content

kelvinlwy/static-website-boilerplate

Repository files navigation

Static Website Boilerplate

Static Website Boilerplate is a front-end template for building static website with webpack.

Dependency Status devDependency Status License: MIT Netlify Status

Quickstart

Clone this repository using

git clone https://github.com/kelvinlwy/static-website-boilerplate <YOUR_PROJECT_NAME>

Move to your project directory

cd <YOUR_PROJECT_NAME>

Install dependencies

yarn install OR npm install

Run the project and see the example website at http://localhost:9000

yarn dev OR npm run dev

Build the project

yarn build OR npm run build

Features

  • Full support for HTML5, JavaScript (Vanilla and ES6) and CSS (Sass)
  • JavaScript - JS transpilation, bundling, minification, and linting (ESLint)
  • CSS - Normalize.css, Neat - A lightweight and flexible Sass grid, transpilation, SASS compliation, minification, and linting (StyleLint)
  • Local development server with hot reloading
  • Uses Webpack for processing and bundling your code
  • Favicon Generation: Automatically generates favicons
  • FORMSPREE Email Contact Form - No PHP, JS required to receive email enquiry.
  • Continuous Deployment with Netlify and TravisCI

License

This project is licensed under the MIT license. For more information see LICENSE.