Skip to content

README.md

Latest commit

 

History

History
96 lines (64 loc) · 2.06 KB

README.md

File metadata and controls

96 lines (64 loc) · 2.06 KB

logo Webpack Starter

License Webpack Status PRs Welcome

A modern, ready-to-use Webpack starter template for kickstarting JavaScript, HTML, and CSS projects. Designed to be lightweight, fast, and easy to customize.

📦 What's Included?

  • ✅ Webpack 5
  • ✅ Development & Production Modes
  • ✅ Babel (for ES6+)
  • ✅ Hot Module Replacement (HMR)
  • ✅ CSS Loader, Style Loader, & Sass
  • ✅ HTML Webpack Plugin (auto-generates index.html)
  • ✅ Asset loader (images, fonts, etc.)
  • ✅ CleanWebpackPlugin (cleans dist/ before build)
  • ✅ Routing SPA (Single Page Application)

🚀 Getting Started

1. Clone the Repository

git clone https://github.com/RenzWay/webpack-starter.git
cd webpack-starter

2. Install Dependencies

npm install
# or
yarn install

💻 Development Mode

Run the development server

npm run dev
# or
yarn dev

📦 Production Mode

npm run build
# or
yarn build

⚙️ Customization

Modify the configuration in webpack.common.js as needed:

  • Add new loaders (e.g., SASS, TypeScript, React, etc.)
  • Add additional plugins (e.g., dotenv, terser, etc.)
  • Change the src/, dist/ directories, or publicPath

🧑‍💻 Who Is This Project For?

This project is suitable for:

  • Developers who want to start a JavaScript project from scratch
  • Learning practical Webpack setup
  • Creating a flexible frontend boilerplate

📜 License

License: MIT
Free to use and modify. See the LICENSE file for details.

🙋 Contact

zenrenz
🔗 GitHub: [https://github.com/RenzWay]

⭐️ Don't Forget

This is not an official Webpack project. Made by community for learning purposes.

If you find this repo useful, don't forget to give it a ⭐️ on GitHub!