generator-beanpod editorconfig travis-ci npm

A gulp.js generator for caffeinated, jadeified webapps

3 years after

Yeoman generator that scaffolds out a front-end web app using gulp for the build process. Heavily based on generator-gulp-webapp.

Why beanpod?

Jade is green, coffee is beans, and I'm not actually that creative.

Features

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

  • CSS Autoprefixing
  • Built-in preview server with BrowserSync
  • Templating with jade
  • Automagically compile Sass with libsass
  • Lint your scripts and styles with coffeelint and scss-lint
  • Map compiled CSS to source stylesheets with source maps
  • Awesome image optimization
  • Automagically wire-up dependencies installed with Bower
  • CoffeeScript support enabled by default
  • E2E testing using webdriver
  • A gulpfile that makes use of ES2015 features by using Babel (an optional gulpfile in coffeescript is available)

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

libsass

Keep in mind that libsass is feature-wise not fully compatible with Ruby Sass. Check out this curated list of incompatibilities to find out which features are missing.

If your favorite feature is missing and you really need Ruby Sass, you can always switch to gulp-ruby-sass and update the styles task in gulpfile accordingly.

Getting Started

  • Install dependencies: npm install --global yo gulp bower
  • Install the generator: npm install --global generator-beanpod
  • Run yo beanpod 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 e2e to run E2E tests in Firefox, or gulp e2e:chrome to use Chrome
  • Run gulp to build your webapp for production
  • Run gulp serve:dist to preview the production build

Docs

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)

Contribute

See the contributing docs.

License

BSD license


Top Contributors

sindresorhus silvenon jaromero addyosmani kevva callumlocke arthurvr stephenplusplus jrcryer jcsrb hemanth alrra passy antleblanc jonkemp al-the-x neilhem JosefJezek aliismayilov appleboy rniemand tmorton mrhooray raphinesse mcauser AveVlad Aweary brunops cvrebert covingtondoan

Releases

-   v0.9.2 zip tar
-   v0.9.1 zip tar
-   v0.9.0 zip tar