Skip to content

Latest commit

 

History

History
177 lines (118 loc) · 7.28 KB

README.md

File metadata and controls

177 lines (118 loc) · 7.28 KB
Raw

Angular Material-Start

This Material start project is a seed for AngularJS Material applications. The project contains a sample AngularJS application and is pre-configured to install the Angular framework and a bunch of development and testing tools for instant web development gratification.

This sample application is intended to be useful as both a learning tool and a skeleton application for a typical AngularJS Material web app: comprised of a Side navigation area and a content area. You can use it to quickly bootstrap your AngularJS webapp projects and dev environment for these projects.

What is the UX?

Below is a snapshot of the Starter-App with the Users' master-detail view. Also shown is the user experience that will be displayed for smaller device sizes. The responsive layout changes to hide the user list, reveal the menu button. In the User Details view, you may also click the share button to show the Contact <User> bottom sheet view.


material-starter-ux2


This Starter app demonstrates how:

  • Angular Material layout and flex options can easily configure HTML containers
  • Angular Material components <md-toolbar>, <md-sidenav>, <md-icon> can be quickly used
  • Custom controllers can use and show <md-bottomsheet> with HTML templates
  • Custom controller can easily, programmatically open & close the SideNav component.
  • Responsive breakpoints and $mdMedia are used
  • Theming can be altered/configured using $mdThemingProvider
  • ARIA features are supported by Angular Material and warnings can be used to improve accessibility.

ES5 & ES6 Tutorials

The repository contains both ES5 and ES6 versions of the application. Traditional development with ES5 standards and solutions are presented here by default. Tutorials are included: step-by-step instructions that clearly demonstrate how the Starter application can be created in minutes.

Wireframe

These tutorials have been presented live, on-stage at ng-conf 2015, Utah.

Developers should checkout the following repository branches for:

  • Branch master: contains the finished, ES5, material-starter application.
  • Branch Starter - ES5 Tutorials: contains the ES5 tutorials with development Lession #1 - #7.
  • Branch Starter - ES6 : same completed application as shown in the master branch, but implemented with ES6 and JSPM (instead of the ES5 in master).

The README for the ES6 branch will provide some details showing how easy, more simplifed, and more manageable it is to develop ES6 applications with Angular Material 1.x. As time permits, we will expand on that information.

Getting Started

Prerequisites

You will need git to clone the material-start repository. You can get git from http://git-scm.com/.

We also use a number of node.js tools to initialize and test material-start. You must have node.js and its package manager (npm) installed. You can get them from http://nodejs.org/.

Clone material-start

To get you started you can simply clone master branch from the Material-Start repository and install the dependencies:

NOTE: The master branch contains the traditional, ES5 implementation familiar to Angular developers.

Clone the material-start repository using git:

git clone https://github.com/angular/material-start.git
cd material-start

If you just want to start a new project without the material-start commit history then you can do:

git clone --depth=1 https://github.com/angular/material-start.git <your-project-name>

The depth=1 tells git to only pull down one commit worth of historical data.

Install Dependencies

We have two kinds of dependencies in this project: tools and AngularJS framework code. The tools help us manage and test the application.

  • We get the tools we depend upon via npm, the node package manager.
  • We also get the AngularJS and Angular Material library code via npm
npm install

You should find that you have one new folder in your project.

  • node_modules - contains the npm packages for the tools we need

Directory Layout

app/                    --> all of the source files for the application
  assets/app.css        --> default stylesheet
  src/           		--> all app specific modules
     users/             --> package for user features
  index.html            --> app layout file (the main html template file of the app)
test/
  karma.conf.js         --> Karma-Jasmine config file (for unit tests)
  protractor-conf.js    --> Protractor config file (for e2e tests)
  unit/					--> Karma-Jasmine unit tests
  e2e/ 			        --> end-to-end tests

Serving the Application Files

While AngularJS is client-side-only technology and it's possible to create AngularJS webapps that don't require a backend server at all, we recommend serving the project files using a local web server during development to avoid issues with security restrictions (sandbox) in browsers. The sandbox implementation varies between browsers, but quite often prevents things like cookies, xhr, etc to function properly when an html page is opened via file:// scheme instead of http://.

Running the App during Development

The angular-seed project comes pre-configured with a local development web server. It is a node.js tool called http-server. You can install http-server globally:

npm install -g live-server

Then you can start your own development web server to serve static files from a folder by running:

Run live-server in a Terminal window
Open browser to url http://localhost:8080/app/

Alternatively, you can choose to configure your own webserver, such as apache or nginx. Just configure your server to serve the files under the app/ directory.

Run UnitTests

Simply open a Terminal window and run npm run tests to start all your Karma unit tests.

Updating Angular

Previously we recommended that you merge in changes to angular-seed into your own fork of the project. Now that the AngularJS framework library code and tools are acquired through package managers (npm) you can use these tools instead to update the dependencies.

You can update the tool dependencies by running:

npm update

This will find the latest versions that match the version ranges specified in the package.json file.

Contact

For more information on AngularJS please check out http://angularjs.org/ For more information on Angular Material, check out https://material.angularjs.org/