This starter project aims to be more productive when starting a webpack project.
This starter project should be working as expected with the following minimal version of:
Dependency | Version |
---|---|
Node | >= v8.0.0 |
NPM | >= v5.0.0 |
- Clone the git repository
# 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
- Start Developing
Dev Version
npm run dev
Prod Version
npm run prod
- Open browser and start editing files!
Site is running at http://localhost:9000
.
├── 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
- Babel
- Linting with ESLint and Stylelint
- Code formatting with Prettier
- Precommit with husky and lint-staged
- Commit conventions with commitlint
It runs linters before committing and prevents errors to go in your repository.
Example with errors
Example after fixing errors