https://github.com/waldronmatt/webpack-boilerplate
Comprehensive Webpack 5 Boilerplate with Express, Netlify, and PWA support.
https://github.com/waldronmatt/webpack-boilerplate
boilerplate boilerplate-webpack browserslist commitizen commitlint eslint htmlhint husky jest lint-staged markdownlint postcss prettier sass secretlint semantic-release stylelint template typescript webpack
Last synced: about 1 month ago
JSON representation
Comprehensive Webpack 5 Boilerplate with Express, Netlify, and PWA support.
- Host: GitHub
- URL: https://github.com/waldronmatt/webpack-boilerplate
- Owner: waldronmatt
- License: mit
- Created: 2022-02-14T04:00:19.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-26T05:00:07.000Z (about 2 years ago)
- Last Synced: 2025-03-28T16:43:39.833Z (about 2 months ago)
- Topics: boilerplate, boilerplate-webpack, browserslist, commitizen, commitlint, eslint, htmlhint, husky, jest, lint-staged, markdownlint, postcss, prettier, sass, secretlint, semantic-release, stylelint, template, typescript, webpack
- Language: JavaScript
- Homepage: https://waldronmatt-webpack-boilerplate.netlify.app/
- Size: 1.8 MB
- Stars: 10
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Webpack Boilerplate
[](https://app.netlify.com/sites/waldronmatt-webpack-boilerplate/deploys)
Comprehensive [Webpack 5 Boilerplate](https://waldronmatt-webpack-boilerplate.netlify.app/) with Express, Netlify, and PWA support.
## Features
- Mixed `js`/`ts` boilerplate with `Jest` and `Eslint`, `Stylelint`, and `Prettier` linting
- Includes the starter [simplepwa template](https://github.com/nikkifurls/simplepwa)
- 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](https://github.com/waldronmatt/shareable-configs) to reduce boilerplate
- ~100% + PWA Optimized Lighthouse Score
## Installation
Install dependencies:
```bash
yarn
```
Install hooks:
```bash
yarn prepare
```
Install `make`:
```bash
[your-package-manager] install make
```
Install `yamllint` and `actionlint`.
## Getting Started
Run dev environment:
```bash
yarn dev
```
Build and serve for Netlify:
```bash
yarn build
```
**Note:** Configure script in Netlify to auto-run via push to `main` branch.
Build for Express:
```bash
yarn prod
```
Serve for Express:
```bash
yarn serve
```
## Commands
Commit changes using conventional changelog:
```bash
yarn commit
```
Lint all `.js`, `.jsx`, `.ts`, `.tsx`, `.css`, `.scss`, `.html`, `.md` files:
```bash
yarn lint
```
**Note**: `release.yml` will run this before versioning and publishing.
Lint `.yml` files:
```bash
make -f MAKEFILE
```
Run all tests:
```bash
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