https://github.com/mmtdigital/generator-mmt-webpack
A yeoman generator to output a webpack boilerplate generator to seed internal MMT Digital projects
https://github.com/mmtdigital/generator-mmt-webpack
Last synced: 9 months ago
JSON representation
A yeoman generator to output a webpack boilerplate generator to seed internal MMT Digital projects
- Host: GitHub
- URL: https://github.com/mmtdigital/generator-mmt-webpack
- Owner: MMTDigital
- License: mit
- Created: 2018-01-03T14:45:29.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-12-06T19:23:53.000Z (over 3 years ago)
- Last Synced: 2025-02-10T09:15:56.030Z (over 1 year ago)
- Language: JavaScript
- Size: 1.48 MB
- Stars: 4
- Watchers: 9
- Forks: 5
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# generator-mmt-webpack
[![NPM version][npm-image]][npm-url]
A yeoman generator to output a webpack boilerplate generator to seed internal MMT Digital projects. If you need to create a fresh front-end project for MMT, this is the tool to help you out!
## Installation
Assuming you have Node installed, installation is simple:
* `npm i -g yo generator-mmt-webpack`
Currently, Mac users will also need to install libpng (we're working on changing this):
* Install Homebrew
* `brew install libpng`
## Usage
**Note: Make sure the directory is empty. The generator will even create your package.json for you.**
To generate your MMT Digital front-end boilerplate, `cd` to the directory where the front-end code for your project is, then run:
* `yo mmt-webpack`
For more information on usage, please check on the internal MMT wiki (Drop a message in the #front-end Slack channel).
### Favicon Support
The webpack setup supports Favicon generation OOTB (Out of the box 👍).
In order to use this functionality; simply replace the image located at: `src/assets/images/favicon.png` with your project's required favicon. The task to generate the different icons, can be found in the base webpack config; should you wish to make an changes to the way icons are generated.
https://github.com/jantimon/favicons-webpack-plugin
## Contribution
If you want to tweak the generator locally and contribute:
* Install Node and Yeoman
* Pull this repo
* `cd` to the cloned root directory
* run `npm link` (this will allow you to globally test, without publishing)
[npm-image]: https://badge.fury.io/js/generator-mmt-webpack.svg
[npm-url]: https://npmjs.org/package/generator-mmt-webpack
## Publishing
If you'd like to publish the package, you'll need to:
* Become a member of the MMT Digital NPM organisation
* Ensure the correct semantic version is set for your release
* Run `npm publish` in the root of the repo!