Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/incentro/generator-ionic-incubator
Yeoman Ionic Incubator
https://github.com/incentro/generator-ionic-incubator
ionic
Last synced: 3 months ago
JSON representation
Yeoman Ionic Incubator
- Host: GitHub
- URL: https://github.com/incentro/generator-ionic-incubator
- Owner: incentro
- License: mit
- Archived: true
- Created: 2015-11-30T11:00:58.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2024-09-11T08:15:09.000Z (4 months ago)
- Last Synced: 2024-09-20T16:31:51.037Z (4 months ago)
- Topics: ionic
- Language: JavaScript
- Homepage:
- Size: 70.3 KB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# generator-ionic-incubator [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url]
> Yeoman generator for Ionic Projects. Sets up a default Ionic template with E2E testing and Unit testing.
## Features
* [Gulp](http://gulpjs.com/) for task automation
* Compiles and concats your sass
* Local development server with [Apache Ripple](http://ripple.incubator.apache.org/) included
* Providing custom Ionic changes in a seperate sass file
* [ng-cordova](http://ngcordova.com/) is built in
## Installation
First, install [Yeoman](http://yeoman.io) and generator-ionic-incubator using [npm](https://www.npmjs.com/) (we assume you have pre-installed [node.js](https://nodejs.org/)).
```bash
npm install -g yo
npm install -g generator-ionic-incubator
```
Then generate your new project inside your app directory:
```bash
yo ionic-incubator
```
To run the application just run:
```bash
gulp
```
## Workflow commands
### `gulp` or `gulp default`
Runs the following commands: `clean, fonts, templates, styles, images, vendor, buildIndex, watchers, serve`
### `gulp -b` or `gulp default -b`
Runs the following commands: `clean, fonts, templates, styles, images, vendor, buildIndex`
### `gulp -e` or `gulp default -e`
Runs the following commands: `clean, fonts, templates, styles, images, vendor, buildIndex, ionic:emulate, watchers`
(Make sure you've added a platform before running this command)
### `gulp -r` or `gulp default -r`
Runs the following commands: `clean, fonts, templates, styles, images, vendor, buildIndex, ionic:run`
(Make sure you've added a platform before running this command)
### `gulp clean`
Deletes the `www` folder.
### `gulp styles`
Concatenates, autoprefixes and strips comments from the scss files into a single main.css file.
### `gulp scripts`
Concatenates, and uglifies js files from the templates and scripts directories into a single app.js file.
### `gulp fonts`
Builds a webfont from the Ionicons webfont.
### `gulp templates`
Copies the templates directory from the `src` folder to the `www` folder.
### `gulp images`
Copies the images directory from the `src` folder to the `www` folder.
### `gulp jsHint`
Lints the js files based on the .jshintrc ruleset.
### `gulp vendor`
Concatenates and uglifies all the vendor scripts and places the vendor.js file in the `www` directory.
### `gulp buildIndex`
Injects the css and js files into the index.html file.
### `gulp karma`
Runs the [Karma](http://karma-runner.github.io/) unit tests.
### `gulp protractor`
Runs the [Protractor](http://www.protractortest.org/) E2E tests.
### `gulp watchers`
Starts watching the scss, fonts, images and template files.
### `gulp ripple`
Launches [Apache Ripple](http://ripple.incubator.apache.org/) (make sure you've added a platform before running this command).
## Changelog
### 0.6.0
* Update to [Ionic 1.3.1](https://github.com/driftyco/ionic/releases/tag/v1.3.1).
### 0.5.0
* Updated dependencies.
* Update to [Ionic 1.3.0](https://github.com/driftyco/ionic/releases/tag/v1.3.0).
### 0.4.0
* Added the Ionic hooks directory.
### 0.3.0
* Updated dependencies.
* Moved the repo to the Incentro account.
### 0.2.0
* [Changed dependency injection for the runBlock](https://github.com/incentro/generator-ionic-incubator/pull/1)
* [Fix for SCSS path and a little typo](https://github.com/incentro/generator-ionic-incubator/pull/2)
* [Fix error after second build](https://github.com/incentro/generator-ionic-incubator/pull/3)
* [Refactoring SCSS part](https://github.com/incentro/generator-ionic-incubator/pull/4)
### 0.1.0
* Update to [Ionic 1.2.0](https://github.com/driftyco/ionic/blob/master/CHANGELOG.md#120-zirconium-zeren-2015-12-09).
* Update the readme.
* Change the tilde into a carret for angular-mocks.
## License
MIT © [Pieter Bogaerts](http://www.goedonthouden.com/)
[npm-image]: https://badge.fury.io/js/generator-ionic-incubator.svg
[npm-url]: https://npmjs.org/package/generator-ionic-incubator
[travis-image]: https://travis-ci.org/incentro/generator-ionic-incubator.svg?branch=master
[travis-url]: https://travis-ci.org/incentro/generator-ionic-incubator
[daviddm-image]: https://david-dm.org/incentro/generator-ionic-incubator.svg?theme=shields.io
[daviddm-url]: https://david-dm.org/incentro/generator-ionic-incubator