Enjoy hand-writing your HTML? Keep it old-school with modern build tools. This boilerplate setup makes it easier to write your own styling, scripts, and mark-up.
- Write SCSS and modern JavaScript code in
srcand build minified, transpiled code for production indist - Continuous integration with linting tests and deploying to
gh-pages - Live reloading with webpack-dev-server
- ES6+ to ES5 transpilation, bundling, and minification
- SCSS to CSS transpilation, bundling, autoprefixing, and minification
- Automatic copying of HTML and static assets from
srctodistfolders - Linting for styles and scripts
- Use this template on GitHub or download the latest release from the Releases page.
- Write all your ES2015+ Javascript code in
src/jsand SCSS styling insrc/style. Store static assets insrc/static. Organize HTML files the way you like. - Available commands:
npm run build: Build files to thedistfolder. Transpiles down to ES5 and bundles all JS intoapp.bundle.js. Transpiles SCSS to CSS and adds prefixing intostyle.bundle.css. Copies static assets and HTML over, and bundled CSS and JS gets added to HTML file.npm run start:dev: Runwebpack-dev-serveratlocalhost:9000. Includes live reloading on any Javascript/SCSS/HTML changes.npm run start: Builds files and runs a local production server onlocalhost:8080withhttp-server.npm run run lint:js: Lints JS with ESLint.npm run lint:styles: Lints SCSS stylesheets with stylelint.npm run lint:html: Lints HTML for a11y issues using pa11y.
This boilerplate contains integration with Travis CI. The build system runs all linting scripts and deploys to GitHub pages upon push to the master branch. However, note that this deployment flow only works for Project Pages, as User and Organization pages only support the master branch flow.
For more information on how to set up alternative deployment processes, check out the Travis CI documentation on deployment. The service can deploy to dozens of cloud providers, including Heroku, AWS, and Firebase.