Giter Club home page Giter Club logo

generator-mmt-webpack's Introduction

generator-mmt-webpack

MMT-Digital NPM version

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)
  • Any problems, just hit me up (James Sear, @jpsear)

generator-mmt-webpack's People

Contributors

jpsear avatar oayres avatar tomukasas avatar dan-fit avatar jarrydtrokis avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.