ng-starter-library

Table of contents

1. Getting Started
2. Installation instructions
3. Usage & Demo
4. API
5. Troubleshooting
6. Contributing
7. License

Getting Started

# 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

npm install ng-library-starter --save

How to use it with:

• angular-cli please refer to getting-started-with-ng-cli
• angular-seed please refer to getting-started-with-angular-seed
• AoT using ngc and rollup please refer to ng-library-starter-with-aot

Usage & Demo

Main source of API documentation and usage scenarious available here: http://jgodi.github.io/angular-library-starter/

Credits

Huge thanks to Valor Software for their great angular component libraries which this was lifted from as a starter!