https://github.com/zewa666/ng2-librarization

A seed for an Angular 2 library
https://github.com/zewa666/ng2-librarization

Last synced: about 12 hours ago
JSON representation

A seed for an Angular 2 library

• Host: GitHub
• URL: https://github.com/zewa666/ng2-librarization
• Owner: zewa666
• License: mit
• Created: 2016-11-22T20:07:36.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2016-12-31T12:54:48.000Z (almost 8 years ago)
• Last Synced: 2024-01-23T16:05:33.406Z (10 months ago)
• Language: JavaScript
• Size: 9.77 KB
• Stars: 0
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# A simple seed for ng2 libraries

This is a simple starter-kit to create your own external 3rd party library.

It's useful to separte code you will need across multiple apps.

## How to get started?

* Clone or download this repo

* Modify the file package.json according to your needs

* Under `src` create all the modules/components/... you need

* Re-export them in `index.ts` for easier access

## Installation with Angular CLI

If you're trying this out locally the easiest way is to link your library locally.

To do so, inside a terminal/cmd, go to the root folder of your library and type `npm link`.

Now over at your apps root folder just install it with `npm link name-of-your-library`.

If you've published your library already to npm's registry, you should be fine with simply running:

`npm install --save name-of-your-library`. 

## Unit Testing

In order to run unit-tests create those in feature-oriented style next to the to be tested items inside

the `src` folder. Make sure the files end with `*.spec.ts`.

To run the unit tests run:

`npm test`