Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/itsabdessalam/webpack-boilerplate
🚀 webpack boilerplate
https://github.com/itsabdessalam/webpack-boilerplate
babel7 boilerplate es6 frontend javascript precommit precommit-errors sass skeleton starter-kit template webpack webpack-boilerplate
Last synced: about 1 month ago
JSON representation
🚀 webpack boilerplate
- Host: GitHub
- URL: https://github.com/itsabdessalam/webpack-boilerplate
- Owner: itsabdessalam
- License: mit
- Created: 2018-12-24T18:38:35.000Z (about 6 years ago)
- Default Branch: develop
- Last Pushed: 2020-08-16T04:55:07.000Z (over 4 years ago)
- Last Synced: 2025-01-03T21:56:24.215Z (about 2 months ago)
- Topics: babel7, boilerplate, es6, frontend, javascript, precommit, precommit-errors, sass, skeleton, starter-kit, template, webpack, webpack-boilerplate
- Language: JavaScript
- Homepage:
- Size: 1.37 MB
- Stars: 3
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Webpack Boilerplate
> This starter project aims to be more productive when starting a webpack project.
## Requirements
This starter project should be working as expected with the following minimal version of:
| Dependency | Version |
| ---------- | :-------: |
| Node | >= v8.0.0 |
| NPM | >= v5.0.0 |
## 🚀 Quick start
1. **Clone the git repository**
```bash
# cloning git repository into `my-webpack-starter` folder
git clone https://github.com/Abdessalam98/webpack-boilerplate my-webpack-starter
# install project dependencies
cd my-webpack-starter && npm install
```
2. **Start Developing**
**Dev Version**
```bash
npm run dev
```
**Prod Version**
```bash
npm run prod
```
3. **Open browser and start editing files!**
> Site is running at http://localhost:9000
## 🧐 What's inside?
```
.
├── node_modules # This is the directory of the modules (npm packages) for your project
├── config # Config files
| ├── index.js
| ├── dev.js
| └── prod.js
├── build # Webpack configuration files
| ├── webpack.common.js
| ├── webpack.dev.js
| └── webpack.prod.js
├── src # This is the directory of entry point files related to the front-end of your site
| ├── index.js # This is the entry point file for Webpack
| └── assets
| ├── fonts
| ├── images
| ├── javascripts
| └── stylesheets
├── .gitignore # This file tells git which files it should not track
├── .prettierrc.json # This is the configuration file for Prettier
├── .eslintrc.json # This is the configuration file for ESLint
├── .stylelintrc.json # This is the configuration file for stylelint
├── commitlint.config.js # This is the configuration file for commitlint
├── index.html # This is the file where Webpack serve content
├── package.json # This file tells npm which packages to install for your project
├── README.md
└── LICENSE
```
## ✨ Features
- Babel
- Linting with ESLint and Stylelint
- Code formatting with Prettier
- Precommit with husky and lint-staged
- Commit conventions with commitlint
## 💩 When trying to commit bad code
It runs linters before committing and prevents errors to go in your repository.
**Example with errors**
**Example after fixing errors**
## Author
[Abdessalam BENHARIRA](https://abdessalam-benharira.me)