README.md

@ssv/ng2-core

Core utilities and services for angular2, such as logger.

In order to contribute please read the Contribution guidelines.

Quick links

Change logs | Project Repository | Contribution guidelines

Installation

Get library via npm

npm install @ssv/ng2-core --save

TypeScript Typings via typings

typings install github:sketch7/ssv-ng2-core --save

Usage

Register module

import {CoreModule} from "@ssv/ng2-core";

@NgModule({
    imports: [
        CoreModule
    ],
    declarations: [
        AppComponent
    ]
}
export class AppModule {
}

Features

• Logger

Getting Started

Setup Machine for Development

Install/setup the following:

• NodeJS v6+
• Visual Studio Code or similar code editor
• TypeScript 2.0+
• Git + SourceTree, SmartGit or similar (optional)
• Ensure to install global NPM modules using the following:

npm install -g git gulp typings karma-cli

Cloning Repo

• Run git clone https://github.com/sketch7/ssv-ng2-core.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)

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