README.md

scaffold-static lets you automate the local development environment setup and build static sites (vanilla-JS) with ease.

Installation

npm install -g scaffold-static

Usage

If you have installed scaffold-static globally,

scaffold-static new <project_name>

or, you could use it with npx

npx scaffold-static new <project_name>

• Supply --use-npm to use npm as the package manager.

How it works

• Choose your favourite CSS framework to work with.

Currently the following CSS frameworks are supported:-

• Bootstrap-3

• Bootstrap-4

• Materialize css

• Foudation css

• Semantic-UI

• Bulma css

• scaffold-static generates the bare minimum boilerplate template with necessary webpack configurations to build the project for production.

  A webpack.config.js file is made available which depends on the following packages:-

  • html-webpack-plugin: Simplifies creation of HTML files to serve your webpack bundles.
  • css-loader - interprets @import and url() like import/require() and will resolve them.
  • style-loader - Injects CSS into the DOM.

• Leverage the advantages put forward by webpack-dev-server such as Hot Module Replacement essentially adding it to the DX.

Contributing

Please see the contributing guidelines

License

GNU GPL V3

Credits

• Created by James George
• Logo by Caneco