https://github.com/gernest/nativescript-angular2-material

NativeScript, Angular2, Firebase and Material Design
https://github.com/gernest/nativescript-angular2-material
Last synced: about 2 months ago
JSON representation
NativeScript, Angular2, Firebase and Material Design
Host: GitHub
URL: https://github.com/gernest/nativescript-angular2-material
Owner: gernest
License: mit
Created: 2017-03-24T23:07:00.000Z (about 8 years ago)
Default Branch: master
Last Pushed: 2016-08-06T19:58:25.000Z (over 8 years ago)
Last Synced: 2025-01-12T19:25:50.423Z (4 months ago)
Language: TypeScript
Homepage:
Size: 1.74 MB
Stars: 0
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project

README

        ![Angular 2 Seed Advanced](https://d2wp4shknjcfjl.cloudfront.net/api/file/olEzxJQ2KcXrZHzbt9UA)![Angular 2 Seed Advanced Integrations](https://d2wp4shknjcfjl.cloudfront.net/api/file/SPLl77rSTuGZ7APrXizi)

[![Angular 2 Style Guide](https://mgechev.github.io/angular2-style-guide/images/badge.svg)](https://github.com/mgechev/angular2-style-guide)

[![Build Status](https://travis-ci.org/NathanWalker/angular2-seed-advanced.svg?branch=master)](https://travis-ci.org/NathanWalker/angular2-seed-advanced)

[![MIT license](http://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT)

[![Dependency Status](https://david-dm.org/NathanWalker/angular2-seed-advanced.svg)](https://david-dm.org/NathanWalker/angular2-seed-advanced)

[![devDependency Status](https://david-dm.org/NathanWalker/angular2-seed-advanced/dev-status.svg)](https://david-dm.org/NathanWalker/angular2-seed-advanced#info=devDependencies)

[![Stack Share](http://img.shields.io/badge/tech-stack-0690fa.svg?style=flat)](http://stackshare.io/NathanWalker/angular-2-seed-advanced)

[![Stories in Progress](https://badge.waffle.io/NathanWalker/angular2-seed-advanced.png?label=in%20progress&title=Stories%20In%20Progress)](https://waffle.io/NathanWalker/angular2-seed-advanced)

#### Considering [Angular 2](https://angular.io/) for a large project? Do you need potential i18n support? Enhanced testing support? Oh and building for multiple platforms too? Web, *native* Mobile (Android/iOS), and even Desktop (Mac, Windows and Linux)?  

This is an **advanced** seed project for Angular 2 apps based on [Minko Gechev's](https://github.com/mgechev) [angular2-seed](https://github.com/mgechev/angular2-seed) that expands on all of its great features to include core support for:

#### Integration with:

- [ngrx/store](https://github.com/ngrx/store) RxJS powered state management, inspired by **Redux**

- [ng2-translate](https://github.com/ocombe/ng2-translate) for i18n 

  - Usage is optional but on by default

  - Up to you and your team how you want to utilize it. It can be easily removed if not needed. 

- [angulartics2](https://github.com/angulartics/angulartics2) Vendor-agnostic analytics for Angular2 applications.

  - Out of box support for [Segment](https://segment.com/)

    - When using the seed, be sure to change your `write_key` [here](https://github.com/NathanWalker/angular2-seed-advanced/blob/master/src/client/index.html#L24)

  - Can be changed to any vendor, [learn more here](https://github.com/angulartics/angulartics2#supported-providers)

- [lodash](https://lodash.com/) Helps reduce blocks of code down to single lines and enhances readability

- [NativeScript](https://www.nativescript.org/) cross platform mobile (w/ native UI) apps. [Setup instructions here](#nativescript-app).

- [Electron](http://electron.atom.io/) cross platform desktop apps (Mac, Windows and Linux). [Setup instructions here](#electron-app).

| ![Multiple Platforms](https://d2wp4shknjcfjl.cloudfront.net/api/file/ihp3WyiqS1WdRYaBEYKn) |

| :---: |

| *The zen of multiple platforms.* Chrome, Android and iPhone all running the same code. |

| ![Desktop](https://d2wp4shknjcfjl.cloudfront.net/api/file/1O4FRGsSHS8g0Lz3EKNy) |

| :---: |

| *Programming Nirvana.* Mac and Windows desktop both running the same code. |

# Table of Contents

- [Enhanced development workflow](#enhanced-development-workflow)

- [Enhanced testing support options](#enhanced-testing-support-options)

- [Prerequisites](#prerequisites)

- [Usage](#usage)

- [NativeScript App](#nativescript-app)

- [Electron App](#electron-app)

- [Testing](#testing)

- [Framework How-Tos](#framework-how-tos)

- [Web Configuration Options](#web-configuration-options)

- [Change Detection OnPush Note](#change-detection-onpush-note)

- [Feature Branches](#feature-branches)

- [Integration Guides](https://github.com/NathanWalker/angular2-seed-advanced/wiki)

- [How best to use for your project](#how-best-to-use-for-your-project)

- [Contributing](#contributing)

- [License](#license)

#### Enhanced development workflow

- Decorators for components which reduce boilerplate for common component setups

- Shared code can be found in `frameworks`:

  - `app`: your shared application architecture code

  - `core`: foundation layer (decorators and low-level services)

  - `analytics`: analytics provided by [Segment](https://segment.com/)

    - Only reports data in **production** build

  - `i18n`: internationalization features

  - `electron`: [Electron](http://electron.atom.io/) specific code

  - `test`: test specific code providing conveniences to make testing your code easier and faster 

#### Enhanced testing support options

- mocks for various services

- configurable provider blocks for easy test setup of common application providers

  - tired of setting up similar providers over and over again for different tests?

  - configure a reusable test provider which can be configured on a case-by-base basis

  - see [example here](https://github.com/NathanWalker/angular2-seed-advanced/blob/master/src/client/app/frameworks/core/testing/providers/core.ts)

- helpers for end-to-end (e2e, integration) tests

- convenient shorthand to reduce test setup boilerplate and enhance speed of writing tests

  - are your test cases buried by multiple import lines requiring you to scroll just to get to the substance of the test?

  - removes noise allowing you to better focus on the substance of the test

  - provides full intellisense support

  - allows your team to add unique shorthands for various testing scenarios specific to your application needs

  - plays nice with `tslint` options like `"no-unused-variable": true` as the api hangs off a plain `Object` instead of globals 

    - what's the value of that you ask? have you ever isolated a test with `iit` or `ddescribe` but didn't import those or vice versa, used `iit` leaving an unused `it` now in your tests? yeah, `tslint` will be all over you :/

    - avoids `unused` variable warnings altogether in tests since you are always using a valid key from the shorthand `Object`

  - see [example here](https://github.com/NathanWalker/angular2-seed-advanced/blob/master/src/client/app/frameworks/test/shorthand/ng2-jasmine.ts)

  

**Advice**: If your project is intended to target a single platform (i.e, web only), then [angular2-seed](https://github.com/mgechev/angular2-seed) is likely more than suitable for your needs. However if your project goals are to target multiple platforms (web, native mobile and native desktop), with powerful out of the box library support and highly configurable/flexible testing options, then you might want to keep reading.

### Prerequisites

* node v5.x.x or higher and npm 3 or higher.

* To run the NativeScript app:

```

npm install -g nativescript

npm install -g typescript

```

## Usage

```bash

git clone --depth 1 https://github.com/NathanWalker/angular2-seed-advanced.git

cd angular2-seed-advanced

# install the project's dependencies

npm install

# watches your files and uses livereload by default

npm start

# api document for the app

npm run serve.docs

# dev build

npm run build.dev

# prod build

npm run build.prod

```

## NativeScript App

#### Setup

```

npm install -g nativescript 

```

#### Dev Workflow

You can make changes to files in `src/client` or `nativescript` folders. A symbolic link exists between the web `src/client` and the `nativescript` folder so changes in either location are mirrored because they are the same directory inside.

Create `.tns.html` and `.tns.css` NativeScript view files for every web component view file you have. You will see an example of the `app.component.html` as a [NativeScript view file here](https://github.com/NathanWalker/angular2-seed-advanced/blob/master/src/client/app/components/app/app.component.tns.html).

#### Run

```

iOS:                      npm run start.ios

iOS (livesync emulator):  npm run start.livesync.ios

iOS (livesync device):    npm run start.livesync.ios.device

// or...

Android:                      npm run start.android

Android (livesync emulator):  npm run start.livesync.android

Android (livesync device):    npm run start.livesync.android.device

```

* Requires an image setup via AVD Manager. [Learn more here](http://developer.android.com/intl/zh-tw/tools/devices/managing-avds.html) and [here](https://github.com/NativeScript/nativescript-cli#the-commands).

## Electron App

#### Develop

```

Mac:      npm run start.desktop

Windows:  npm run start.desktop.windows

```

#### Develop with livesync

```

Mac:      npm run start.livesync.desktop

Windows:  npm run start.livesync.desktop.windows

```

#### Release: Package Electron App for Mac, Windows or Linux

```

Mac:      npm run build.desktop.mac

Windows:  npm run build.desktop.windows

Linux:    npm run build.desktop.linux

```

## Testing

```bash

npm test

# Debug - In two different shell windows

npm run build.test.watch      # 1st window

npm run karma.start           # 2nd window

# code coverage (istanbul)

# auto-generated at the end of `npm test`

# view coverage report:

npm run serve.coverage

# e2e (aka. end-to-end, integration) - In three different shell windows

# Make sure you don't have a global instance of Protractor

# npm run webdriver-update <- You will need to run this the first time

npm run webdriver-start

npm run serve.e2e

npm run e2e

# e2e live mode - Protractor interactive mode

# Instead of last command above, you can use:

npm run e2e.live

```

You can learn more about [Protractor Interactive Mode here](https://github.com/angular/protractor/blob/master/docs/debugging.md#testing-out-protractor-interactively)

## Framework How-Tos

### i18n

* how to add a language?

  - `src/client/assets/i18n/`

    - add `[language code].json` (copy existing one and adapt the translation strings)

  - `src/client/app/frameworks/app/services/app-config.service.spec.ts`

    - fix test

  - `src/client/app/frameworks/app/services/app-config.service.ts`

    - add language to `SUPPORTED_LANGUAGES`

  - `src/client/app/frameworks/i18n/components/lang-switcher.component.spec.ts`

    - fix test

## Web Configuration Options

Default application server configuration

```javascript

var PORT             = 5555;

var LIVE_RELOAD_PORT = 4002;

var DOCS_PORT        = 4003;

var APP_BASE         = '/';

```

Configure at runtime

```bash

npm start -- --port 8080 --reload-port 4000 --base /my-app/

```

## Change Detection OnPush Note

*Please Note:* The seed uses Angular's `ChangeDetectionStrategy.OnPush` by default which requires some understanding of immutability and one-way data flows. Please check out the following resources to learn more:

* http://blog.thoughtram.io/angular/2016/02/22/angular-2-change-detection-explained.html

* http://victorsavkin.com/post/110170125256/change-detection-in-angular-2

* http://www.syntaxsuccess.com/viewarticle/change-detection-in-angular-2.0

* http://ngcourse.rangle.io/handout/change-detection/change_detection_strategy_onpush.html

If you experience issues with changes not occuring in your views, you can disable this by commenting out [these lines](https://github.com/NathanWalker/angular2-seed-advanced/blob/master/src/client/app/frameworks/core/decorators/utils.ts#L43-L48). The seed uses `OnPush` by default because it  provides optimal performance and if you decide to turn it off while developing your application, you can always turn it back on when you're ready to refactor your data services to utilize `OnPush` properly.

## Feature Branches

Several branches exist with certain features integrated:

* [ui-router-ng2](https://github.com/NathanWalker/angular2-seed-advanced/tree/ui-router)

## How best to use for your project

#### Setup

1. Download a zip of the seed. (**Do not fork**)

2. `npm run git.setup` - This will initialize `git` as well as setup `upstream` properly.

3. `git remote add origin ...your private repo...`

4. `npm run git.prepare` - This will prepare git to handle the merge

5. `npm run git.merge` - This will fetch upstream and run the first merge (*Important)

  * IMPORTANT: You will see a wall of Conflicts after doing above (a Conflict for every single file). This is normal. There actually will not be any problematic conflicts as it's just reporting every single file which both sides (`upstream` and your first commit) added.

6. `git add .; git commit -m'ready'`. Yes, you will be committing all those conflicts, which actually are not a problem in this 1 time case.

7. Now you have `git` setup and ready to develop your application as well as merge in upstream changes in the future.

8. `npm install` (and all other usage docs in this `README` apply)

9. Create a new `framework` for your application in `src/client/app/frameworks` to build your codebase out. Say your app is called `AwesomeApp`, then create `awesomeapp` and start building out all your components and services in there. Create other frameworks as you see fit to organize.

10. If you don't want an integration that comes out of box with this seed; for example. let's say you don't want to use i18n. Then just delete the `i18n`, remove `ng2-translate` as dependency root `package.json` and `nativescript/package.json`. Then remove any references to `i18n` throughout.

You can read more about [configuring a remote for a fork here](https://help.github.com/articles/configuring-a-remote-for-a-fork/)

#### Merging latest upstream changes

1. `npm run git.merge.preview` - This will fetch `upstream` and show you how the merge would look

2. `npm run git.merge` - This will actually do the merge

3. Handle any conflicts to get latest upstream into your application.

4. Continue building your app.

You can read more about [syncing a fork here](https://help.github.com/articles/syncing-a-fork/).

If you have any suggestions to this workflow, please post [here](https://github.com/NathanWalker/angular2-seed-advanced/issues).

## Contributing

Please see the [CONTRIBUTING](https://github.com/NathanWalker/angular2-seed-advanced/blob/master/CONTRIBUTING.md) file for guidelines.

# Awesome Contributors

[](https://github.com/mgechev) |[](https://github.com/ludohenin) |[](https://github.com/NathanWalker) |[](https://github.com/d3viant0ne) |[](https://github.com/tarlepp) |[](https://github.com/Shyam-Chen) |

:---: |:---: |:---: |:---: |:---: |:---: |

[mgechev](https://github.com/mgechev) |[ludohenin](https://github.com/ludohenin) |[NathanWalker](https://github.com/NathanWalker) |[d3viant0ne](https://github.com/d3viant0ne) |[tarlepp](https://github.com/tarlepp) |[Shyam-Chen](https://github.com/Shyam-Chen) |

[](https://github.com/TheDonDope) |[](https://github.com/nareshbhatia) |[](https://github.com/hank-ehly) |[](https://github.com/kiuka) |[](https://github.com/jesperronn) |[](https://github.com/the-ult) |

:---: |:---: |:---: |:---: |:---: |:---: |

[TheDonDope](https://github.com/TheDonDope) |[nareshbhatia](https://github.com/nareshbhatia) |[hank-ehly](https://github.com/hank-ehly) |[kiuka](https://github.com/kiuka) |[jesperronn](https://github.com/jesperronn) |[the-ult](https://github.com/the-ult) |

[](https://github.com/aboeglin) |[](https://github.com/gkalpak) |[](https://github.com/ryzy) |[](https://github.com/JakePartusch) |[](https://github.com/njs50) |[](https://github.com/pgrzeszczak) |

:---: |:---: |:---: |:---: |:---: |:---: |

[aboeglin](https://github.com/aboeglin) |[gkalpak](https://github.com/gkalpak) |[ryzy](https://github.com/ryzy) |[JakePartusch](https://github.com/JakePartusch) |[njs50](https://github.com/njs50) |[pgrzeszczak](https://github.com/pgrzeszczak) |

[](https://github.com/natarajanmca11) |[](https://github.com/JohnCashmore) |[](https://github.com/jerryorta-dev) |[](https://github.com/domfarolino) |[](https://github.com/LuxDie) |[](https://github.com/larsthorup) |

:---: |:---: |:---: |:---: |:---: |:---: |

[natarajanmca11](https://github.com/natarajanmca11) |[JohnCashmore](https://github.com/JohnCashmore) |[jerryorta-dev](https://github.com/jerryorta-dev) |[domfarolino](https://github.com/domfarolino) |[LuxDie](https://github.com/LuxDie) |[larsthorup](https://github.com/larsthorup) |

[](https://github.com/juristr) |[](https://github.com/e-oz) |[](https://github.com/ouq77) |[](https://github.com/tsm91) |[](https://github.com/devanp92) |[](https://github.com/hAWKdv) |

:---: |:---: |:---: |:---: |:---: |:---: |

[juristr](https://github.com/juristr) |[e-oz](https://github.com/e-oz) |[ouq77](https://github.com/ouq77) |[tsm91](https://github.com/tsm91) |[devanp92](https://github.com/devanp92) |[hAWKdv](https://github.com/hAWKdv) |

[](https://github.com/ivannugo) |[](https://github.com/c-ice) |[](https://github.com/markharding) |[](https://github.com/gotenxds) |[](https://github.com/ojacquemart) |[](https://github.com/Nightapes) |

:---: |:---: |:---: |:---: |:---: |:---: |

[ivannugo](https://github.com/ivannugo) |[c-ice](https://github.com/c-ice) |[markharding](https://github.com/markharding) |[gotenxds](https://github.com/gotenxds) |[ojacquemart](https://github.com/ojacquemart) |[Nightapes](https://github.com/Nightapes) |

[](https://github.com/evanplaice) |[](https://github.com/vyakymenko) |[](https://github.com/divramod) |[](https://github.com/turbohappy) |[](https://github.com/troyanskiy) |[](https://github.com/ip512) |

:---: |:---: |:---: |:---: |:---: |:---: |

[evanplaice](https://github.com/evanplaice) |[vyakymenko](https://github.com/vyakymenko) |[divramod](https://github.com/divramod) |[turbohappy](https://github.com/turbohappy) |[troyanskiy](https://github.com/troyanskiy) |[ip512](https://github.com/ip512) |

[](https://github.com/Green-Cat) |[](https://github.com/Yonet) |[](https://github.com/TuiKiken) |[](https://github.com/tandu) |[](https://github.com/amaltsev) |[](https://github.com/yassirh) |

:---: |:---: |:---: |:---: |:---: |:---: |

[Green-Cat](https://github.com/Green-Cat) |[Yonet](https://github.com/Yonet) |[TuiKiken](https://github.com/TuiKiken) |[tandu](https://github.com/tandu) |[amaltsev](https://github.com/amaltsev) |[yassirh](https://github.com/yassirh) |

[](https://github.com/sonicparke) |[](https://github.com/brendanbenson) |[](https://github.com/eppsilon) |[](https://github.com/brian428) |[](https://github.com/briantopping) |[](https://github.com/cadriel) |

:---: |:---: |:---: |:---: |:---: |:---: |

[sonicparke](https://github.com/sonicparke) |[brendanbenson](https://github.com/brendanbenson) |[eppsilon](https://github.com/eppsilon) |[brian428](https://github.com/brian428) |[briantopping](https://github.com/briantopping) |[cadriel](https://github.com/cadriel) |

[](https://github.com/dszymczuk) |[](https://github.com/dstockhammer) |[](https://github.com/dwido) |[](https://github.com/totev) |[](https://github.com/sfabriece) |[](https://github.com/koodikindral) |

:---: |:---: |:---: |:---: |:---: |:---: |

[dszymczuk](https://github.com/dszymczuk) |[dstockhammer](https://github.com/dstockhammer) |[dwido](https://github.com/dwido) |[totev](https://github.com/totev) |[sfabriece](https://github.com/sfabriece) |[koodikindral](https://github.com/koodikindral) |

[](https://github.com/allenhwkim) |[](https://github.com/alexweber) |[](https://github.com/hpinsley) |[](https://github.com/jeffbcross) |[](https://github.com/Jimmysh) |[](https://github.com/johnjelinek) |

:---: |:---: |:---: |:---: |:---: |:---: |

[allenhwkim](https://github.com/allenhwkim) |[alexweber](https://github.com/alexweber) |[hpinsley](https://github.com/hpinsley) |[jeffbcross](https://github.com/jeffbcross) |[Jimmysh](https://github.com/Jimmysh) |[johnjelinek](https://github.com/johnjelinek) |

[](https://github.com/fourctv) |[](https://github.com/justindujardin) |[](https://github.com/lihaibh) |[](https://github.com/Brooooooklyn) |[](https://github.com/nulldev07) |[](https://github.com/inkidotcom) |

:---: |:---: |:---: |:---: |:---: |:---: |

[fourctv](https://github.com/fourctv) |[justindujardin](https://github.com/justindujardin) |[lihaibh](https://github.com/lihaibh) |[Brooooooklyn](https://github.com/Brooooooklyn) |[nulldev07](https://github.com/nulldev07) |[inkidotcom](https://github.com/inkidotcom) |

[](https://github.com/mjwwit) |[](https://github.com/ocombe) |[](https://github.com/gdi2290) |[](https://github.com/typekpb) |[](https://github.com/philipooo) |[](https://github.com/pidupuis) |

:---: |:---: |:---: |:---: |:---: |:---: |

[mjwwit](https://github.com/mjwwit) |[ocombe](https://github.com/ocombe) |[gdi2290](https://github.com/gdi2290) |[typekpb](https://github.com/typekpb) |[philipooo](https://github.com/philipooo) |[pidupuis](https://github.com/pidupuis) |

[](https://github.com/redian) |[](https://github.com/Bigous) |[](https://github.com/robbatt) |[](https://github.com/robertpenner) |[](https://github.com/sclausen) |[](https://github.com/heavymery) |

:---: |:---: |:---: |:---: |:---: |:---: |

[redian](https://github.com/redian) |[Bigous](https://github.com/Bigous) |[robbatt](https://github.com/robbatt) |[robertpenner](https://github.com/robertpenner) |[sclausen](https://github.com/sclausen) |[heavymery](https://github.com/heavymery) |

[](https://github.com/tjvantoll) |[](https://github.com/tapas4java) |[](https://github.com/gitter-badger) |[](https://github.com/vincentpalita) |[](https://github.com/Yalrafih) |[](https://github.com/blackheart01) |

:---: |:---: |:---: |:---: |:---: |:---: |

[tjvantoll](https://github.com/tjvantoll) |[tapas4java](https://github.com/tapas4java) |[gitter-badger](https://github.com/gitter-badger) |[vincentpalita](https://github.com/vincentpalita) |[Yalrafih](https://github.com/Yalrafih) |[blackheart01](https://github.com/blackheart01) |

[](https://github.com/butterfieldcons) |[](https://github.com/jgolla) |[](https://github.com/sebfag) |[](https://github.com/ultrasonicsoft) |[](https://github.com/taguan) |

:---: |:---: |:---: |:---: |:---: |

[butterfieldcons](https://github.com/butterfieldcons) |[jgolla](https://github.com/jgolla) |[sebfag](https://github.com/sebfag) |[ultrasonicsoft](https://github.com/ultrasonicsoft) |[taguan](https://github.com/taguan) |

## License

MIT
ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/gernest/nativescript-angular2-material

Awesome Lists containing this project

README
