## Links
- [Documentation](http://valor-software.com/highway-blue/)
- [Release Notes](https://github.com/valor-software/highway-blue/blob/development/CHANGELOG.md)
- [Slack Community](https://ngx-slack.herokuapp.com)
## 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
highway-blue contains all core (and not only) Bootstrap components powered by Angular. So you don't need to include original JS components, but we are using markup and css provided by Bootstrap.
# Installation instructions
Install `highway-blue` from `npm`
```bash
npm install highway-blue --save
```
You will need bootstrap styles (Bootstrap 3)
```
```
Or Bootstrap 4
```
```
To enable bootstrap 4 theme templates in highway-blue, please read
[this](https://github.com/valor-software/highway-blue/blob/development/docs/getting-started/bootstrap4.md) .
# Usage & Demo
Main source of API documentation and usage scenarios available here:
[https://valor-software.com/highway-blue/](https://valor-software.com/highway-blue/)
Additionally you can find demos and docs deployed from latest code with angular v4 and angular v5
Server side rendered version of this documentation available here
# API
Check demo page for API [reference](https://valor-software.com/highway-blue/)
## How to use it with:
- `angular-cli` please refer to [getting-started-with-ng-cli](https://github.com/valor-software/highway-blue/tree/development/docs/getting-started/ng-cli.md)
- `angular-seed` please refer to [getting-started-with-angular-seed](https://github.com/valor-software/highway-blue/tree/development/docs/getting-started/angular-seed.md)
- `system.js` (and [angular2 quickstart](https://angular.io/docs/ts/latest/quickstart.html)) please checkout [sample repository](https://github.com/valor-software/angular2-quickstart)
- `plnkr` sample available [here](http://bit.ly/highway-blue-plnkr)
- `AoT using ngc and rollup` please refer to [highway-blue-with-aot](https://github.com/valor-software/highway-blue/tree/development/docs/getting-started/aot.md)
- `Bootstrap 4 and angular-cli` please refer to [using-with-bootstrap-4-and-angular-cli](https://github.com/valor-software/highway-blue/tree/development/docs/getting-started/bootstrap4.md)
- `ASP.NET Core 2.0` please refer to [using-with-asp.net-core-2](https://github.com/csegyud/ASPNETCore_highway-blue_Sample/blob/master/README.md)
# How to build lib for development
First time
- clone repository
- `npm install`
- `npm run test` it will build the lib and create a link in `node_modules`
To run bootstrap 3 and 4 demo:
- `npm run demo.serve` to serve local demo. This is for testing only, without watchers.
For local development run
- `npm run build.watch` in first terminal
- `ng serve` in second
If you want to run the demo with Angular Universal:
- `npm run demo.serve-universal`
# Troubleshooting
So if you are in trouble, here's where you can look for help.
The best place to ask questions is on [StackOverflow (under the `highway-blue` tag)](https://stackoverflow.com/questions/tagged/highway-blue)
You can also join [our Slack channel](https://ngx-slack.herokuapp.com/) and link your stackoverflow question there. But try to avoid asking generic help questions directly on Slack since they can easily get lost in the chat. You can also [search among the existing GitHub issues](https://github.com/valor-software/highway-blue/issues?utf8=%E2%9C%93&q=is%3Aissue).
If, **and only if**, none of the above helped, please open a [new issue](https://github.com/valor-software/highway-blue/issues/new).
# Contribution
Are very welcome! And remember, contribution is not only PRs and code, but any help with docs or helping other developers to solve issues are very appreciated! Thanks in advance!
Please read our [contribution guidelines](https://github.com/valor-software/highway-blue/blob/development/CONTRIBUTING.md).
## If you need more modules check [here](https://github.com/valor-software/ng2-plans)
Please read central `ngx` modules [readme](https://github.com/valor-software/ng2-plans) for details, plans and approach
## Credits
Crossbrowser testing sponsored by [Browser Stack](https://www.browserstack.com)
[](https://www.browserstack.com)
