https://github.com/phucbm/js-webpack-boilerplate

A boilerplate to build JavaScript library with Webpack.
https://github.com/phucbm/js-webpack-boilerplate

boilerplate es6 webpack

Last synced: 25 days ago
JSON representation

A boilerplate to build JavaScript library with Webpack.

• Host: GitHub
• URL: https://github.com/phucbm/js-webpack-boilerplate
• Owner: phucbm
• License: mit
• Created: 2022-07-10T10:46:33.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-07T03:49:22.000Z (7 months ago)
• Last Synced: 2024-04-08T04:25:38.629Z (7 months ago)
• Topics: boilerplate, es6, webpack
• Language: JavaScript
• Homepage:
• Size: 630 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
#  JavaScript x Webpack (Library Boilerplate)

A starter pack to develop your JS library with:

- ⚙️ ES6 module

- ⚙️ Webpack with HRM ready

- ⚙️ SCSS

- ⚙️ Separated dev and public server

Output formats:

- ✅ UMD file with minified and unminified versions.

- ✅ Module file for publishing to `npm`.

> CSS file will not be included in the production build.

## Todos

1. Update `package.json` with your library names.

2. Library script start with `/src/_index.js`, **do not rename this file**.

3. Create your dev site in folder `/dev`.

## Deployment

```shell the packages

# Install

npm i

# Run dev server

npm run dev

# Generate UMD and module version

npm run prod

# Build production site (e.g. for Netlify host)

npm run build

```

---

Libraries that used this boilerplate:

- [Easy Tab & Accordion (ETA)](https://github.com/viivue/easy-tab-accordion)

- [Easy Popup](https://github.com/viivue/easy-popup)

- [Easy Select](https://github.com/viivue/easy-select)