Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/taniarascia/webpack-boilerplate
📦 ‎ A sensible webpack 5 boilerplate.
https://github.com/taniarascia/webpack-boilerplate
webpack webpack-boilerplate webpack5
Last synced: 2 days ago
JSON representation
📦 ‎ A sensible webpack 5 boilerplate.
- Host: GitHub
- URL: https://github.com/taniarascia/webpack-boilerplate
- Owner: taniarascia
- License: mit
- Created: 2019-09-03T19:02:57.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-03-14T20:13:30.000Z (10 months ago)
- Last Synced: 2024-10-29T15:34:37.628Z (2 months ago)
- Topics: webpack, webpack-boilerplate, webpack5
- Language: JavaScript
- Homepage:
- Size: 1.05 MB
- Stars: 2,392
- Watchers: 42
- Forks: 569
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-github-star - webpack-boilerplate
- awesome-boilerplate - Webpack Boilerplate
README
# 📦 webpack Boilerplate
[](https://opensource.org/licenses/MIT)
Sensible webpack 5 boilerplate using Babel, PostCSS and Sass.
## Installation
Clone this repo and npm install.
```bash
npm i
```
## Usage
### Development server
```bash
npm start
```
You can view the development server at `localhost:8080`.
### Production build
```bash
npm run build
```
> Note: Install [http-server](https://www.npmjs.com/package/http-server) globally to deploy a simple server.
```bash
npm i -g http-server
```
You can view the deploy by creating a server in `dist`.
```bash
cd dist && http-server
```
## Features
- [webpack](https://webpack.js.org/)
- [Babel](https://babeljs.io/)
- [Sass](https://sass-lang.com/)
- [PostCSS](https://postcss.org/)
## Dependencies
### webpack
- [`webpack`](https://github.com/webpack/webpack) - Module and asset bundler.
- [`webpack-cli`](https://github.com/webpack/webpack-cli) - Command line interface for webpack
- [`webpack-dev-server`](https://github.com/webpack/webpack-dev-server) - Development server for webpack
- [`webpack-merge`](https://github.com/survivejs/webpack-merge) - Simplify development/production configuration
- [`cross-env`](https://github.com/kentcdodds/cross-env) - Cross platform configuration
### Babel
- [`@babel/core`](https://www.npmjs.com/package/@babel/core) - Transpile ES6+ to backwards compatible JavaScript
- [`@babel/plugin-proposal-class-properties`](https://babeljs.io/docs/en/babel-plugin-proposal-class-properties) - Use properties directly on a class (an example Babel config)
- [`@babel/preset-env`](https://babeljs.io/docs/en/babel-preset-env) - Smart defaults for Babel
### Loaders
- [`babel-loader`](https://webpack.js.org/loaders/babel-loader/) - Transpile files with Babel and webpack
- [`sass-loader`](https://webpack.js.org/loaders/sass-loader/) - Load SCSS and compile to CSS
- [`sass`](https://www.npmjs.com/package/sass) - Node Sass
- [`postcss-loader`](https://webpack.js.org/loaders/postcss-loader/) - Process CSS with PostCSS
- [`postcss-preset-env`](https://www.npmjs.com/package/postcss-preset-env) - Sensible defaults for PostCSS
- [`css-loader`](https://webpack.js.org/loaders/css-loader/) - Resolve CSS imports
- [`style-loader`](https://webpack.js.org/loaders/style-loader/) - Inject CSS into the DOM
### Plugins
- [`clean-webpack-plugin`](https://github.com/johnagan/clean-webpack-plugin) - Remove/clean build folders
- [`copy-webpack-plugin`](https://github.com/webpack-contrib/copy-webpack-plugin) - Copy files to build directory
- [`html-webpack-plugin`](https://github.com/jantimon/html-webpack-plugin) - Generate HTML files from template
- [`mini-css-extract-plugin`](https://github.com/webpack-contrib/mini-css-extract-plugin) - Extract CSS into separate files
- [`css-minimizer-webpack-plugin`](https://webpack.js.org/plugins/css-minimizer-webpack-plugin/) - Optimize and minimize CSS assets
### Linters
- [`eslint`](https://github.com/eslint/eslint) - Enforce styleguide across application
- [`eslint-config-prettier`](https://github.com/prettier/eslint-config-prettier) - Implement prettier rules
- - [`prettier`](https://github.com/prettier/prettier) - Dependency for `prettier-webpack-plugin` plugin
- [`eslint-import-resolver-webpack`](https://github.com/benmosher/eslint-plugin-import/tree/master/resolvers/webpack) - Throw exceptions for import/export in webpack
## Author
- [Tania Rascia](https://www.taniarascia.com)
## License
This project is open source and available under the [MIT License](LICENSE).