Skip to content

Latest commit

 

History

History
55 lines (44 loc) · 2.55 KB

README.md

File metadata and controls

55 lines (44 loc) · 2.55 KB

ng-starter-library npm version npm downloads

Angular 2 Style Guide Build Status codecov Dependency Status

NPM NPM

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 [email protected]: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:

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!