Giter VIP home page Giter VIP logo

waldronmatt / webpack-boilerplate Goto Github PK

View Code? Open in Web Editor NEW
10.0 3.0 0.0 1.84 MB

Comprehensive Webpack 5 Boilerplate with Express, Netlify, and PWA support.

Home Page: https://waldronmatt-webpack-boilerplate.netlify.app/

License: MIT License

JavaScript 62.16% HTML 27.54% SCSS 6.16% TypeScript 3.45% Shell 0.69%
webpack browserslist commitizen commitlint eslint husky jest lint-staged postcss prettier

webpack-boilerplate's Introduction

Webpack Boilerplate

Netlify Status

Comprehensive Webpack 5 Boilerplate with Express, Netlify, and PWA support.

Features

  • Mixed js/ts boilerplate with Jest and Eslint, Stylelint, and Prettier linting
  • Includes the starter simplepwa template
  • Server and serverless builds with Netlify and Express
  • Conventional Commits prompt and commit linting using Commitizen and Commitlint
  • Husky hooks to lint and test staged files using Lint-Staged
  • Automated releases using Semantic-Release
  • Uses my shareable configs to reduce boilerplate
  • ~100% + PWA Optimized Lighthouse Score

Installation

Install dependencies:

yarn

Install hooks:

yarn prepare

Install make:

[your-package-manager] install make

Install yamllint and actionlint.

Getting Started

Run dev environment:

yarn dev

Build and serve for Netlify:

yarn build

Note: Configure script in Netlify to auto-run via push to main branch.

Build for Express:

yarn prod

Serve for Express:

yarn serve

Commands

Commit changes using conventional changelog:

yarn commit

Lint all .js, .jsx, .ts, .tsx, .css, .scss, .html, .md files:

yarn lint

Note: release.yml will run this before versioning and publishing.

Lint .yml files:

make -f MAKEFILE

Run all tests:

yarn test

Note: release.yml will run this before versioning and publishing.

Click and Go!

  1. Click Use this template to create your own copy
  2. Clone down the newly created repository
  3. Run yarn and yarn prepare to install dependencies and git hooks
  4. Update your package.json
  5. Delete CHANGELOG.md
  6. Customize your repo and commit changes using the commit script in package.json
  7. Use a commit type like feat
  8. Push out your changes. This will trigger a release with a version of 1.0.0

License

MIT

webpack-boilerplate's People

Contributors

dependabot[bot] avatar semantic-release-bot avatar waldronmatt avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

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.