Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/healthonnet/generator-onsenui-ngcordova
A yeoman Generator for scaffolding Onsen UI / ngCordova App
https://github.com/healthonnet/generator-onsenui-ngcordova
Last synced: 5 days ago
JSON representation
A yeoman Generator for scaffolding Onsen UI / ngCordova App
- Host: GitHub
- URL: https://github.com/healthonnet/generator-onsenui-ngcordova
- Owner: healthonnet
- Created: 2016-02-19T13:07:52.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2016-09-06T14:09:25.000Z (over 8 years ago)
- Last Synced: 2024-08-16T16:49:24.741Z (4 months ago)
- Language: JavaScript
- Size: 2.88 MB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-cordova - generator-onsenui-ngcordova
README
# generator-onsenui-ngcordova
> A Yeoman Generator to Scaffold an [OnsenUI](http://onsenui.io/) (v.1.3.4) [ngCordova](http://ngcordova.com) app
> Based on a Fork of [arvindr21](https://github.com/arvindr21)'s project [generator-onsenui-phonegap](https://github.com/arvindr21/generator-onsenui-phonegap) and adapted to add ngCordova.
## 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.*
```bash
$ 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-onsenui-ngcordova from npm, run:
```bash
$ npm install -g generator-onsenui-ngcordova
```
Finally, initiate the generator:
```bash
$ yo onsenui-ngcordova
```
You can select and install all [cordova plugins supported by ngCordova](http://ngcordova.com/docs/plugins/) !
All templates use OnsenUI v1.3.4 (Jul 1, 2015)
You can pick from one of the 5 available [templates](http://onsenui.io/guide/getting_started.html#template)
* Minimum
* Sliding Menu
* Tab bar
* Master-Detail
* Split View
Once you select a template, Yeoman will scaffold an `onsenui-ngcordova` app for you.
### Run the App
To run the Onsenui ngCordova app in your browser, execute
```bash
$ grunt
```
This will start a server at port `1881`. Navigate to `http://localhost:1881` to see the app running.
_Note: When you open the browser, you will find `cordova.js` as a 404 resource. This will be resolved, when you issue a PhoneGap build._
Now you can use [grunt-cordova-ng](https://github.com/GrayBullet/grunt-cordova-ng) tasks to manage your cordova project.
You can also edit your build task.
```bash
$ grunt build
```
### Checklist
* [x] Grunt task - lint js/css (improve build task)
* [ ] Ask for SCSS developpement option (different gruntfile)
* [x] Grunt task - build generation
* [ ] Generate updated cordova (6+) project (Ask for platforms)
### 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