Giter Club home page Giter Club logo

well-meaning-webpack-workflow's Introduction

Well Meaning Webpack Workflow

A basic Webpack build process for developing static HTML websites and applications. All comments welcome.

CI coming soon.

Features

  • Write SCSS and modern JavaScript code in src and build minified, transpiled code for production in dist
  • 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 src to dist folders
  • Linting for styles and scripts
  • A template engine (Handlebars)
  • Import and install Javascript files
  • Custom Fonts

Installation

Installs with the package manager of your choice, for instance node or yarn

npm install

or

yarn install

Usage

  • Write all your ES2015+ Javascript code in src/js and SCSS styling in src/style. Store static assets in src/static. Organize HTML files the way you like.
  • Available commands:
    • npm run build: Build files to the dist folder. Transpiles down to ES5 and bundles all JS into app.bundle.js. Transpiles SCSS to CSS and adds prefixing into style.bundle.css. Copies static assets and HTML over, and bundled CSS and JS gets added to HTML file.
    • npm run start:dev: Runs webpack-dev-server at localhost:9000. Includes live reloading on any Javascript/SCSS/HTML changes.
    • npm run start: Builds files and runs a local production server on localhost:8080 with http-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, performs a fresh build runs on the dist folder to check your work.

well-meaning-webpack-workflow's People

Watchers

 avatar

well-meaning-webpack-workflow's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.