Skip to content

Commit 69d1323

Browse files
committed
Update docs with up to date screenshots
1 parent c922707 commit 69d1323

16 files changed

+77
-47
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,18 @@ Follow the commit history of this project to learn how to build a yeoman angular
55

66
[![Build Status](https://travis-ci.org/infomofo/cordova-angular-md-template.svg?branch=master)](https://travis-ci.org/infomofo/cordova-angular-md-template)
77

8+
Sample screenshots
9+
------------------
10+
11+
![A Demo Material-Angular App running in Grunt](docs/images/GruntSlideNav.png)
12+
![A Demo Material-Angular App running on iOS](docs/images/iPhoneSlideNav.png)
13+
![A Demo Material-Angular App running on Android](docs/images/AndroidSlideNav.png)
14+
15+
![A Form running in Grunt](docs/images/GruntForm.png)
16+
![A Form running in Android](docs/images/AndroidFormNumberInput.png)
17+
![A Form running on iOS](docs/images/iPhoneForm.png)
18+
19+
820
To build a cordova app
921
---------------------
1022

@@ -38,6 +50,12 @@ Directory Structure
3850
* .bower.json - contains the bower dependencies
3951
* Gruntfile.js - contains the build process for this application
4052

53+
Modifications
54+
-------------
55+
56+
Additions to the app can be made with the standard [yeoman generator-angular](https://github.com/yeoman/generator-angular)
57+
commands. For example, a new route, tab, and controller can be added with the command <code>yo angular:route myroute</code>
58+
4159
Generated files not in git
4260
--------------------------
4361

app/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,9 @@
5555

5656
<!-- build:js({.tmp,app}) scripts/scripts.js -->
5757
<script src="scripts/app.js"></script>
58-
<script src="scripts/router.js"></script>
5958
<script src="scripts/controllers/main.js"></script>
6059
<script src="scripts/controllers/about.js"></script>
60+
<script src="scripts/controllers/myroute.js"></script>
6161
<!-- endbuild -->
6262
</body>
6363
</html>

app/scripts/app.js

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,37 @@ var app = angular
1919
'ngMaterial'
2020
]);
2121

22+
app
23+
.config(function($compileProvider){
24+
$compileProvider.aHrefSanitizationWhitelist(/^\s*(https?|ftp|mailto|file|chrome-extension):/);
25+
})
26+
.config(function ($routeProvider) {
27+
$routeProvider
28+
.when('/', {
29+
templateUrl: 'views/main.html',
30+
controller: 'MainCtrl'
31+
})
32+
.when('/about', {
33+
templateUrl: 'views/about.html',
34+
controller: 'AboutCtrl'
35+
})
36+
.when('/list', {
37+
templateUrl: 'views/list.html'
38+
})
39+
.when('/form', {
40+
templateUrl: 'views/form.html'
41+
})
42+
.when('/dialog', {
43+
templateUrl: 'views/dialog.html'
44+
})
45+
.when('/tabs', {
46+
templateUrl: 'views/tabs.html'
47+
})
48+
.otherwise({
49+
redirectTo: '/'
50+
});
51+
});
52+
2253
app.run(function ($rootScope, $location, $mdSidenav, $mdToast) {
2354

2455
var searchActive = false;

app/scripts/router.js

Lines changed: 0 additions & 33 deletions
This file was deleted.

app/views/dialog.html

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
<md-content class="md-padding" flex layout="column" layout-margin>
22
<h3>Ways to display various messages to a user</h3>
33

4-
<md-button class="md-fab md-fab-bottom-right" aria-label="Time">
5-
<i class="fa fa-clock-o fa-2x"></i>
6-
</md-button>
74
<section layout="row" layout-align="center center">
85
<md-button class="md-raised" style="margin: 1em;" ng-click="showAlertToast('Toasty!')">Toast</md-button>
96
<md-button class="md-raised md-primary" style="margin: 1em;" ng-click="showUndoToastPersistent('Toasty!')">Toast with Action</md-button>

app/views/form.html

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<md-content class="md-padding">
22
<h3>Various form elements</h3>
3-
<md-button class="md-fab md-fab-bottom-right" aria-label="Time">
3+
<md-button class="md-fab md-fab-bottom-right md-accent" aria-label="Time">
44
<i class="fa fa-clock-o fa-2x"></i>
55
</md-button>
66

@@ -14,6 +14,12 @@ <h3>Various form elements</h3>
1414
<input type="number"/>
1515
</md-input-container>
1616
</div>
17+
<div layout="row">
18+
<md-input-container flex>
19+
<label>Textarea input</label>
20+
<textarea columns="1" ></textarea>
21+
</md-input-container>
22+
</div>
1723
<div layout="row" layout-fill>
1824
<md-switch aria-label="Switch 1" ng-model="data.cb1">
1925
Switch 1: {{data.cb1}}

app/views/main.html

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,32 @@ <h1>Hello!</h1>
44
</div>
55

66
<div class="row marketing">
7-
<h4>HTML5 Boilerplate</h4>
7+
<h4>Demo App</h4>
88
<p>
9-
HTML5 Boilerplate is a professional front-end template for building fast, robust, and adaptable web apps or sites.
9+
This is a demo app testing the use of angular/material widgets in a cordova application container.
1010
</p>
1111

12-
<h4>Angular</h4>
12+
<h4>How to use this app</h4>
1313
<p>
14-
AngularJS is a toolset for building the framework most suited to your application development.
14+
<ol>
15+
<li>Clone the repo from infomofo/cordova-angular-md-template</li>
16+
<li>Run <code>npm install</code></li>
17+
<li>Run <code>grunt</code></li>
18+
<li>From there you can run this application in one of three ways:
19+
<ul>
20+
<li>Run <code>grunt serve</code> to open the application as a standard webpage</li>
21+
<li>Run <code>cd cordova; cordova emulate ios</code> to emulate it on an ios simulator running on your machine</li>
22+
<li>Run <code>cd cordova; cordova run android</code> to emulate it on an android simulator running on your machine, or to a connected android device with debugging options turned on.</li>
23+
</ul>
24+
</li>
25+
</ol>
1526
</p>
1627

17-
<h4>Karma</h4>
18-
<p>Spectacular Test Runner for JavaScript.</p>
28+
<h4>Application scaffolding and organization</h4>
29+
<p>.</p>
30+
31+
<h4>Other features</h4>
32+
<p>This app will also contain example grunt tests that can be run on an integration server, such as Travis.</p>
1933
</div>
2034

21-
<md-button class="md-fab md-fab-bottom-right" aria-label="Time">
22-
<i class="fa fa-clock-o fa-2x"></i>
23-
</md-button>
2435
</md-content>

docs/images/AndroidAppSlideNav.png

67.8 KB
Loading

docs/images/AndroidForm.png

118 KB
Loading
108 KB
Loading
-79.5 KB
Binary file not shown.
-43.4 KB
Binary file not shown.

docs/images/GruntForm.png

101 KB
Loading

docs/images/GruntSlideNav.png

140 KB
Loading

docs/images/iPhoneAppSlideNav.png

-150 KB
Loading

docs/images/iPhoneForm.png

61.1 KB
Loading

0 commit comments

Comments
 (0)