{"id":15388249,"url":"https://github.com/georapbox/webpack-library-starter-kit","last_synced_at":"2025-04-15T18:30:36.272Z","repository":{"id":40798098,"uuid":"131738120","full_name":"georapbox/webpack-library-starter-kit","owner":"georapbox","description":"Webpack starter kit for creating libraries","archived":false,"fork":false,"pushed_at":"2023-02-27T23:22:58.000Z","size":1339,"stargazers_count":16,"open_issues_count":3,"forks_count":5,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-29T00:33:34.614Z","etag":null,"topics":["commonjs","commonjs-bundle","es6","library","starter-kit","umd","umd-bundle","umd-modules","webpack4"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/georapbox.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-05-01T16:48:37.000Z","updated_at":"2023-03-09T01:36:06.000Z","dependencies_parsed_at":"2024-10-19T03:34:20.822Z","dependency_job_id":null,"html_url":"https://github.com/georapbox/webpack-library-starter-kit","commit_stats":{"total_commits":56,"total_committers":2,"mean_commits":28.0,"dds":0.4285714285714286,"last_synced_commit":"926f5f8fb4ba9c66145d37abaa642063453838d1"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/georapbox%2Fwebpack-library-starter-kit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/georapbox%2Fwebpack-library-starter-kit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/georapbox%2Fwebpack-library-starter-kit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/georapbox%2Fwebpack-library-starter-kit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/georapbox","download_url":"https://codeload.github.com/georapbox/webpack-library-starter-kit/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249128861,"owners_count":21217231,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["commonjs","commonjs-bundle","es6","library","starter-kit","umd","umd-bundle","umd-modules","webpack4"],"created_at":"2024-10-01T14:56:08.882Z","updated_at":"2025-04-15T18:30:35.490Z","avatar_url":"https://github.com/georapbox.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build Status](https://travis-ci.com/georapbox/webpack-library-starter-kit.svg?branch=master)](https://travis-ci.com/georapbox/webpack-library-starter-kit)\n\n# webpack-library-starter-kit\n\nWebpack starter kit for creating libraries (Input: ES6, Output: UMD, CommonJS)\n\n## Features\n\n- Webpack 4\n- Babel 7\n- ES6 as a source\n- Exports in UMD and CommonJS\n- ES6 test setup with [Mocha](https://mochajs.org/) and [Chai](http://www.chaijs.com/)\n- Test coverage with [nyc command-line-client for Istanbul](https://github.com/istanbuljs/nyc)\n- Linting with [ESLint](https://eslint.org/)\n- Basic [Travis](https://travis-ci.org/) configuration\n\n## Getting started\n\n### 1. Setup the library's name\n\n- Open `webpack.config.js` and change the value of `libraryName` variable with your library's name.\n- Open `package.json` and change the following properties with your library's equivalent\n  - `name`\n  - `version`\n  - `description`\n  - `main`\n  - `repository`\n  - `author`\n  - `license`\n  - `bugs`\n  - `homepage`\n\n### 2. Install dependencies\n\n- Run `npm install` to install the library's dependencies.\n\n### 3. Build for development\n\n- Having all the dependencies installed run `npm run dev`. This command will generate a `UMD` unminified bundle under the `dist` folder and a `CommonJS` bundle under the `lib` folder. It will also watch for changes in source files to recompile.\n\n### 4. Build for production\n\n- Having all the dependencies installed run `npm run build`. This command will generate two `UMD` bundles (unminified and minified) under the `dist` folder and a `CommonJS` bundle under the `lib` folder.\n\n## Scripts\n\n- `npm run build` - Produces production version of library under `dist` folder for UMD bundle and `lib` folder for `CommonJS` bundle.\n- `npm run build:umd` - Produces an **unminified** UMD bundle under the `dist` folder.\n- `npm run build:umdmin` - Produces an **minified** UMD bundle under the `dist` folder.\n- `npm run build:commonjs` - Produces a CommonJS bundle under the `lib` folder.\n- `npm run dev` - Produces a development version of library (both UMD and CommonJS) and runs a watcher to watch for changes.\n- `npm run dev:umd` - Produces an unminified UMD bundle under the `dist` folder and runs a watcher to watch for changes.\n- `npm run dev:commonjs` - Produces a CommonJS bundle under the `lib` folder and runs a watcher to watch for changes.\n- `npm run test` - Runs the tests.\n- `npm run coverage` - Runs the tests and provides with test coverage information.\n- `npm run lint` - Lints the source code with ESlint.\n- `npm run clean` - Deletes `dist`, `lib` and `coverage` folders.\n- `npm run prepare` - Run both BEFORE the package is packed and published, on local npm install without any arguments, and when installing git dependencies.\n\n## Misc\n\n- By default all source code is located under the `src` folder.\n- Be default `dist` and `lib` folders are excluded from source control but included for npm. You can change this behavior by not excluding these folders inside the `.gitignore` file.\n- The starter kit assumes that all tests are located under `test` folder with `.spec.js` extension.\n\n## License\n\n[The MIT License (MIT)](https://georapbox.mit-license.org/@2018)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgeorapbox%2Fwebpack-library-starter-kit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgeorapbox%2Fwebpack-library-starter-kit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgeorapbox%2Fwebpack-library-starter-kit/lists"}