Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sukima/generator-webappify
https://github.com/sukima/generator-webappify
Last synced: 17 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/sukima/generator-webappify
- Owner: sukima
- License: mit
- Created: 2013-10-22T04:01:09.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2016-11-21T01:51:14.000Z (almost 8 years ago)
- Last Synced: 2024-10-21T20:56:27.045Z (30 days ago)
- Language: JavaScript
- Size: 16.6 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# generator-webappify [](https://travis-ci.org/sukima/generator-webappify)
A generator for [Yeoman](http://yeoman.io).
This generator will make a simple webapp which uses [Jasmine][], [CoffeeScript][], and [Browserify][]. Out of the box it supports [testem][].
You can any choose the following packages: [jQuery][], [jQuery Mobile][JQM], [Underscore][], [Backbone][], and [Q][]
It uses [Jasmine][] for the test framework. And will also include [Jasmine jQuery][jasminejq] if needed.
[CoffeeScript]: http://coffeescript.org/
[Browserify]: http://browserify.org/
[testem]: https://github.com/airportyh/testem
[Jasmine]: https://jasmine.github.io/
[jasminejq]: https://github.com/velesin/jasmine-jquery
[jQuery]: http://jquery.com/
[JQM]: http://jquerymobile.com/
[Underscore]: http://underscorejs.org/
[Backbone]: http://backbonejs.org/
[Q]: http://documentup.com/kriskowal/q/
## Grunt tasks
- `default` - Build `app/app.js` from modules in `src/` folder.
- `test` - Build `test/specs.js` from specs in `test/spec/` folder.
- `clean` - Removes build files.
## Output
output/
├── Gruntfile.coffee
├── bower.json
├── index.html
├── package.json
├── src
│ ├── app.coffee
│ └── my_module.coffee
├── test
│ ├── fixtures
│ ├── index.html
│ └── spec
│ ├── basic_spec.coffee
│ └── my_module_spec.coffee
└── testem.json
## Getting Started
### What is Yeoman?
Trick question. It's not a thing. It's this guy:
Basically, he wears a top hat, lives in your computer, and waits for you to tell him what kind of application you wish to create.
Not every new computer comes with a Yeoman pre-installed. He lives in the [npm](https://npmjs.org) package repository. You only have to ask for him once, then he packs up and moves into your hard drive. *Make sure you clean up, he likes new and shiny things.*
```
$ npm install -g yo
```
### Yeoman Generators
Yeoman travels light. He didn't pack any generators when he moved in. You can think of a generator like a plug-in. You get to choose what type of application you wish to create, such as a Backbone application or even a Chrome extension.
To install generator-webappify from npm, run:
```
$ npm install -g generator-webappify
```
Finally, initiate the generator:
```
$ yo webappify
```
### Getting To Know Yeoman
Yeoman has a heart of gold. He's a person with feelings and opinions, but he's very easy to work with. If you think he's too opinionated, he can be easily convinced.
If you'd like to get to know Yeoman better and meet some of his friends, [Grunt](http://gruntjs.com) and [Bower](http://bower.io), check out the complete [Getting Started Guide](https://github.com/yeoman/yeoman/wiki/Getting-Started).
## License
[MIT License](http://en.wikipedia.org/wiki/MIT_License)