Scaffold out a Chrome app
JavaScript CoffeeScript HTML CSS
Latest commit 4dbb0b5 Jan 26, 2016 @ragingwind ragingwind Merge pull request #62 from bcjordan/patch-1
Small typo & phrasing changes

Chrome App generator Build Status

Maintainer: Jimmy Moon

Chrome Apps boilerplate generator that creates everything you need to get started with development. To test, go to: chrome://extensions, enable Developer mode and load app as an unpacked extension.

Getting Started

  • First make a new directory, and cd into it: mkdir my-new-chromeapp && cd $_
  • Install the generator: npm install -g generator-chromeapp
  • Run: yo chromeapp


Available generators:


Sets up a new Chrome App, generating all the boilerplate you need to get started.


yo chromeapp


Create manifest.json or append permission into manifest.json. You can choose permission to put into manifest.json


yo chromeapp:permission


You can create a new Chrome App with the google-chrome-app samples on GitHub.


yo chromeapp:samples


Creates a production build, production files to zip file. You can publish zip file to Chrome Web Store.


grunt build


Support two preview mode. LiveReload/run/debug your Chrome App on Chrome browser and Chrome app container.

  • grunt debug - Default, run you Chrome App on Chrome app container

  • grunt debug:server - Run you Chrome App on Chrome browser like 'serve' task of webapp.


  • --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.

  • --skip-pull

    Skips the pull command of git which checks the google-chrome-app samples on GitHub

  • --coffee

    Add support for CoffeeScript.

  • --compass

    Add support for Compass.

WARN, Compiled files that generated by coffee or compass will be remained if your Chrome App running on Chrome App container (with grunt debug). You should remove or ignore that files if you don't want to commit to repo.


See the contributing docs


BSD license