https://github.com/jgodi/angular-library-starter

Angular starter library that is AOT/code-splitting ready
https://github.com/jgodi/angular-library-starter

angular library starter-kit

Last synced: 2 days ago
JSON representation

Angular starter library that is AOT/code-splitting ready

• Host: GitHub
• URL: https://github.com/jgodi/angular-library-starter
• Owner: jgodi
• Created: 2017-04-03T17:23:08.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2017-04-17T14:40:11.000Z (about 9 years ago)
• Last Synced: 2025-08-13T07:52:01.493Z (9 months ago)
• Topics: angular, library, starter-kit
• Language: JavaScript
• Homepage: https://jgodi.github.io/angular-library-starter
• Size: 368 KB
• Stars: 3
• Watchers: 0
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

          
# ng-starter-library [![npm version](https://badge.fury.io/js/ng-starter-library.svg)](http://badge.fury.io/js/ng-starter-library) [![npm downloads](https://img.shields.io/npm/dm/ng-starter-library.svg)](https://npmjs.org/ng-starter-library)

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

[![Build Status](https://travis-ci.org/jgodi/angular-library-starter.svg?branch=master)](https://travis-ci.org/jgodi/angular-library-starter)

[![codecov](https://codecov.io/gh/jgodi/angular-library-starter/branch/master/graph/badge.svg)](https://codecov.io/gh/jgodi/angular-library-starter)

[![Dependency Status](https://david-dm.org/jgodi/angular-library-starter.svg)](https://david-dm.org/jgodi/angular-library-starter)

[![NPM](https://nodei.co/npm/ng-starter-library.png?downloads=true&downloadRank=true&stars=true)](https://npmjs.org/ng-starter-library)

[![NPM](https://nodei.co/npm-dl/ng-starter-library.png?height=3&months=9)](https://npmjs.org/ng-starter-library)

## Table of contents

1. [Getting Started](#getting-started)

2. [Installation instructions](#installation-instructions)

3. [Usage & Demo](#usage--demo)

4. [API](#api)

5. [Troubleshooting](#troubleshooting)

6. [Contributing](#contribution)

7. [License](#license)

# Getting Started

```bash

# clone the repository

git clone git@github.com:jgodi/angular-library-starter.git

# install dependencies

npm install # yarn

# build the src

npm run build

# link the library to demo

npm run link

# start the demo

npm start

# to live-watch the library, in a second terminal run

npm run build:watch

```

# Installation instructions

Install `ng-library-starter` from `npm`

```bash

npm install ng-library-starter --save

```

## How to use it with:

 - `angular-cli` please refer to [getting-started-with-ng-cli](https://github.com/jgodi/angular-library-starter/blob/master/docs/getting-started/ng-cli.md)

 - `angular-seed` please refer to [getting-started-with-angular-seed](https://github.com/jgodi/angular-library-starter/blob/master/docs/getting-started/angular-seed.md)

 - `AoT using ngc and rollup` please refer to [ng-library-starter-with-aot](https://github.com/jgodi/angular-library-starter/blob/master/docs/getting-started/aot.md)

# Usage & Demo

Main source of API documentation and usage scenarious available here:

[http://jgodi.github.io/angular-library-starter/](http://jgodi.github.io/angular-library-starter/)

## Credits

Huge thanks to [Valor Software](https://github.com/valor-software) for their great angular component libraries which this was lifted from as a starter!