Nondigestible Purple Mayonnaise
Join us to discuss the challenges, solutions and best practices for in-house JavaScript code sharing. Tuesday, 12/17 at 10am PT/1pm ET.Sign up here »

generator-cardboard

1.0.2 • Public • Published

Generator Cardboard Build Status

Yeoman generator that scaffolds out a web app complete with a virtual reality environment built with THREE.js which is Google Cardboard compatible.

Features

  • CSS Autoprefixing
  • Built-in preview server with LiveReload
  • Automagically compile Sass
  • Automagically lint your scripts
  • Automagically wire up your Bower components with grunt-wiredep.
  • Awesome Image Optimization (via OptiPNG, pngquant, jpegtran and gifsicle)
  • Mocha Unit Testing with PhantomJS
  • Bootstrap for Sass (Optional)
  • Leaner Modernizr builds (Optional)

Getting Started

  • Install: npm install -g generator-cardboard
  • Run: yo cardboard
  • Run grunt for building and grunt serve for preview. --allow-remote option for remote access.

Third-Party Dependencies

(HTML/CSS/JS/Images/etc)

Third-party dependencies are managed with grunt-wiredep. Add new dependencies using Bower and then run the Grunt task to load them:

$ bower install --save jquery
$ grunt wiredep

This works if the package author has followed the Bower spec. If the files are not automatically added to your source code, check with the package's repo for support and/or file an issue with them to have it updated.

To manually add dependencies, bower install --save depName to get the files, then add a script or style tag to your index.html or another appropriate place.

The components are installed in the root of the project at /bower_components. To reference them from index.html, use src="bower_components" or src="/bower_components". Treat the bower_components directory as if it was a sibling to index.html.

Testing Note: a project checked into source control and later checked out needs to have bower install run from the test folder as well as from the project root.

Options

  • --skip-install

    Skips the automatic execution of bower and npm after scaffolding has finished.

  • --test-framework=<framework>

    Defaults to mocha. Can be switched for another supported testing framework like jasmine.

Contribute

See the yeoman contributing docs.

License

BSD license

Install

npm i generator-cardboard

DownloadsWeekly Downloads

5

Version

1.0.2

License

BSD

Last publish

Collaborators

  • avatar