# ngx-onboarding

This repository conatains the ngx-onboarding library and the Angular project as the workspace and example app.

## Report Bugs

Please use GitHub issues to report Bugs. Include all necessary information (OS, Browser, Versions, ...) and a detailed description of the issue.

## Contribute

Feel free to to support us and fix bugs or develop features. If you want to contribute send us a pull request.
Please ensure that the code matches the angular style guides and is covered by unit tests. 

### Development server

Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.

### Code scaffolding

Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.

### Build

Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build.

### Running unit tests

Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).

Run the npm `test-app` to execute the unit tests of the hosting angular application.

### Lint

Run the npm `lint` to lint the code.

### Running end-to-end tests

Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).

### Build and package Library

Run `build-lib` npm task to create the package in dist folder.

Run `npm-pack` npm task to pack the content of the dist folder.

Run `package` npm task to build and package the library.