bookstore.sdk v0.0.0

obg.ng2.sdk-sample

SDK Sample using Angular2 consuming globals and best practices

Quick links

Change logs | Project Repository | Contribution guidelines

Getting Started

Installation

npm install obg.ng2.sdk-sample --save
typings install npm:obg.ng2.sdk-sample -save

Usage

Register providers

import {SDK_SAMPLE_PROVIDERS} from "obg.ng2.sdk-sample";

// within bootstrap or AppComponent
providers: [
	SDK_SAMPLE_PROVIDERS
]

import {HeroService} from "obg.ng2.sdk-sample";

heroes: Hero[];

@Injectable()
constructor(
	private heroService: HeroService
) {
}

ngOnInit() {
	this.heroService.getAll()
		.subscribe(x => {
			this.heroes = x;
		});
}

Contributing to the project

In order to contribute please read the Contribution guidelines.

Setup Machine for Development

Install/setup the machine by following Setup Machine for Development - Libraries WIKI.

Setup Project to Develop

Cloning Repo

• Open SourceTree
• Clone project repo from project git
• Switch to develop branch

Project Setup

The following process need to be executed in order to get started.

npm install

Building the code

gulp build

In order to view all other tasks invoke gulp or check the gulp tasks directly.

Running the tests

gulp test

Development utils

Trigger gulp watch

Handles compiling of changes.

gulp watch

Running Continuous Tests

Spawns test runner and keep watching for changes.

gulp tdd

Preparation for Release

gulp prepare-release --bump major|minor|patch|prerelease (default: patch) --version-suffix beta (default: rc - only applies to prerelease)

Check out the release workflow guide in order to guide you creating a release and distributing it.