Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yeoman/generator-chromeapp
Scaffold out a Chrome app
https://github.com/yeoman/generator-chromeapp
Last synced: 3 months ago
JSON representation
Scaffold out a Chrome app
- Host: GitHub
- URL: https://github.com/yeoman/generator-chromeapp
- Owner: yeoman
- Archived: true
- Created: 2012-11-21T21:48:26.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2017-02-13T17:35:20.000Z (over 7 years ago)
- Last Synced: 2024-03-25T20:00:24.379Z (3 months ago)
- Language: JavaScript
- Homepage: http://yeoman.io
- Size: 211 KB
- Stars: 310
- Watchers: 22
- Forks: 59
- Open Issues: 2
-
Metadata Files:
- Readme: readme.md
- Contributing: contributing.md
Lists
- awesome-starters - generator-chromeapp
README
# Chrome App generator [](http://travis-ci.org/yeoman/generator-chromeapp)
Maintainer: [Jimmy Moon](https://github.com/ragingwind)
> 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`
## Generators
Available generators:
* [chromeapp](#app) (aka [chromeapp:app](#app))
* [chromeapp:permission](#permission)
* [chromeapp:samples](#samples)
### App
Sets up a new Chrome App, generating all the boilerplate you need to get started.
Example:
```bash
yo chromeapp
```
### Permission
Create manifest.json or append permission into manifest.json. You can choose permission to put into manifest.json
Example:
```bash
yo chromeapp:permission
```
### Samples
You can create a new Chrome App with the [google-chrome-app samples](https://github.com/GoogleChrome/chrome-app-samples) on GitHub.
Example:
```bash
yo chromeapp:samples
```
## Build
Creates a production build, production files to zip file. You can publish zip file to Chrome Web Store.
Examples:
```bash
grunt build
```
## Debug
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.
## 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`.
* `--skip-pull`
Skips the `pull` command of `git` which checks the [google-chrome-app samples](https://github.com/GoogleChrome/chrome-app-samples) on GitHub
* `--coffee`
Add support for [CoffeeScript](http://coffeescript.org/).
* `--compass`
Add support for [Compass](http://compass-style.org/).
> 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.
## Contribute
See the [contributing docs](https://github.com/yeoman/yeoman/blob/master/contributing.md)
## License
[BSD license](http://opensource.org/licenses/bsd-license.php)