Skip to content
This repository was archived by the owner on Sep 13, 2024. It is now read-only.

Commit c1509b3

Browse files
committed
Updated the readme and Ionic.
1 parent 845b957 commit c1509b3

File tree

5 files changed

+89
-10
lines changed

5 files changed

+89
-10
lines changed

README.md

+84-4
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
## Features
55

66
* [Gulp](http://gulpjs.com/) for task automation
7-
* Compiles and concats your SASS
7+
* Compiles and concats your sass
88
* Local development server with [Apache Ripple](http://ripple.incubator.apache.org/) included
9-
* Providing custom Ionic changes in a seperate SASS file
9+
* Providing custom Ionic changes in a seperate sass file
1010
* [ng-cordova](http://ngcordova.com/) is built in
1111

1212
## Installation
@@ -18,10 +18,10 @@ npm install -g yo
1818
npm install -g generator-ionic-incubator
1919
```
2020

21-
Then generate your new project:
21+
Then generate your new project inside your app directory:
2222

2323
```bash
24-
yo generator-ionic-incubator
24+
yo ionic-incubator
2525
```
2626

2727
To run the application just run:
@@ -30,6 +30,86 @@ To run the application just run:
3030
gulp
3131
```
3232

33+
## Workflow commands
34+
35+
### `gulp` or `gulp default`
36+
37+
Runs the following commands: `clean, fonts, templates, styles, images, vendor, buildIndex, watchers, serve`
38+
39+
### `gulp -b` or `gulp default -b`
40+
41+
Runs the following commands: `clean, fonts, templates, styles, images, vendor, buildIndex`
42+
43+
### `gulp -e` or `gulp default -e`
44+
45+
Runs the following commands: `clean, fonts, templates, styles, images, vendor, buildIndex, ionic:emulate, watchers`
46+
(Make sure you've added a platform before running this command)
47+
48+
### `gulp -r` or `gulp default -r`
49+
50+
Runs the following commands: `clean, fonts, templates, styles, images, vendor, buildIndex, ionic:run`
51+
(Make sure you've added a platform before running this command)
52+
53+
### `gulp clean`
54+
55+
Deletes the `www` folder.
56+
57+
### `gulp styles`
58+
59+
Concatenates, autoprefixes and strips comments from the scss files into a single main.css file.
60+
61+
### `gulp scripts`
62+
63+
Concatenates, and uglifies js files from the templates and scripts directories into a single app.js file.
64+
65+
### `gulp fonts`
66+
67+
Builds a webfont from the Ionicons webfont.
68+
69+
### `gulp templates`
70+
71+
Copies the templates directory from the `src` folder to the `www` folder.
72+
73+
### `gulp images`
74+
75+
Copies the images directory from the `src` folder to the `www` folder.
76+
77+
### `gulp jsHint`
78+
79+
Lints the js files based on the .jshintrc ruleset.
80+
81+
### `gulp vendor`
82+
83+
Concatenates and uglifies all the vendor scripts and places the vendor.js file in the `www` directory.
84+
85+
### `gulp buildIndex`
86+
87+
Injects the css and js files into the index.html file.
88+
89+
### `gulp karma`
90+
91+
Runs the [Karma](http://karma-runner.github.io/) unit tests.
92+
93+
### `gulp protractor`
94+
95+
Runs the [Protractor](http://www.protractortest.org/) E2E tests.
96+
97+
### `gulp watchers`
98+
99+
Starts watching the scss, fonts, images and template files.
100+
101+
### `gulp ripple`
102+
103+
Launches [Apache Ripple](http://ripple.incubator.apache.org/) (make sure you've added a platform before running this command).
104+
105+
## Changelog
106+
107+
### 0.1.0
108+
109+
* Update to [Ionic 1.2.0](https://github.com/driftyco/ionic/blob/master/CHANGELOG.md#120-zirconium-zeren-2015-12-09).
110+
* Update the readme.
111+
* Change the tilde into a carret for angular-mocks.
112+
33113
## License
34114

35115
MIT © [Pieter Bogaerts](http://www.goedonthouden.com/)

generators/app/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ module.exports = yeoman.generators.Base.extend({
1313

1414
// Have Yeoman greet the user.
1515
this.log(yosay(
16-
'Welcome to the sublime ' + chalk.red('generator-ionic-incubator') + ' generator!'
16+
'Welcome to the sublime ' + chalk.red('ionic-incubator') + ' generator!'
1717
));
1818

1919
var prompts = [{

generators/app/templates/_bower.json

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@
55
"devDependencies": {},
66
"dependencies": {
77
"angular": "^1.4.3",
8-
"angular-mocks": "~1.4.3",
8+
"angular-mocks": "^1.4.8",
99
"angular-resource": "^1.4.3",
10-
"ionic": "^1.1.1",
11-
"ngCordova": "^0.1.20-alpha"
10+
"ionic": "^1.2.0",
11+
"ngCordova": "^0.1.17-alpha"
1212
},
1313
"resolutions": {
1414
"angular": "1.4.3"

generators/app/templates/_gulpfile.js

-1
Original file line numberDiff line numberDiff line change
@@ -259,7 +259,6 @@ gulp.task('watchers', function() {
259259
plugins.livereload.listen();
260260
gulp.watch('src/styles/**/*.scss', ['styles']);
261261
gulp.watch('src/fonts/**', ['fonts']);
262-
gulp.watch('src/icons/**', ['iconfont']);
263262
gulp.watch('src/images/**', ['images']);
264263
gulp.watch('src/scripts/**/*.js', ['buildIndex']);
265264
gulp.watch('./vendor.json', ['vendor']);

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "generator-ionic-incubator",
3-
"version": "0.0.2",
3+
"version": "0.1.0",
44
"description": "Yeoman generator for Ionic Projects",
55
"homepage": "",
66
"bugs": "https://github.com/PizzaPete/generator-ionic-incubator/issues",

0 commit comments

Comments
 (0)