andershopkins/mirummsp-yo-generator

A Yeoman generator for rapidly scaffolding static sites, forked from Yeoman's Webapp generator.

Mirum MSP Front End Generator

Mirum MSP Front End Generator that scaffolds out a front-end web app using gulp for the build process and assemble for creating static sites or scaffolding projects. Forked and modified from Yeoman

Features

Please see our gulpfile for up to date information on what we support.

• enable ES2015 features using Babel
• CSS Autoprefixing
• Built-in preview server with BrowserSync
• Automagically compile Sass with libsass
• Automagically lint your scripts
• Map compiled CSS to source stylesheets with source maps
• Awesome image optimization
• Automagically wire-up dependencies installed with Bower

For more information on what this generator can do for you, take a look at the gulp plugins used in our package.json.

Getting Started

• Install dependencies: npm install --global yo gulp-cli bower
• Install generator dependencies: cd /path/to/mirummsp-yo-generator && npm-install
• Link to the generator: npm link
• Run mkdir my-webapp && cd $_ then yo mspfed to scaffold your webapp
• Run gulp serve to preview and watch for changes
• Run bower install --save <package> to install frontend dependencies
• Run gulp serve:test to run the tests in the browser
• Run gulp build to build your webapp for production
• Run gulp serve:dist to preview the production build

Recommended Editor Plugins

VS Code

• ESLint
• SassLint

Atom

• linter-eslint
• linter-sass-lint

Sublime Text

• SublimeLinter-eslint
• SublimeLinter-contrib-sass-lint

Docs

• getting started with this generator
• recipes for integrating other popular technologies like Jade
• details about our Bower setup
• contribution docs and FAQ, good to check before posting an issue

Options

• --skip-welcome-message Skips Yeoman's greeting before displaying options.
• --skip-install-message Skips the the message displayed after scaffolding has finished and before the dependencies are being installed.
• --skip-install Skips the automatic execution of bower and npm after scaffolding has finished.
• --test-framework=<framework> Either mocha or jasmine. Defaults to mocha.
• --no-babel Scaffolds without Babel support. This only applies to app/scripts, you can still write ES2015 in the gulpfile, depending on what your version of Node supports.

Contribute

See the contributing docs.

License

BSD license