Skip to content

Commit ae0c5e7

Browse files
committed
chore(package): initial commit
0 parents  commit ae0c5e7

File tree

5 files changed

+24718
-0
lines changed

5 files changed

+24718
-0
lines changed

.github/ISSUE_TEMPLATE.md

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
<!--
2+
IF YOU DON'T FILL OUT THE FOLLOWING INFORMATION YOUR ISSUE MIGHT BE CLOSED WITHOUT INVESTIGATING
3+
-->
4+
### Bug Report or Feature Request (mark with an `x`)
5+
```
6+
- [ ] bug report -> please search issues before submitting
7+
- [ ] feature request
8+
```
9+
10+
### OS and Version?
11+
<!--
12+
> Windows 7, 8 or 10. Linux (which distribution).macOS(Yosemite ? El Capitan? Sierra ?)
13+
-->
14+
15+
### Versions
16+
<!--
17+
Output from: `ng --version`, in case you are using Angular CLI.
18+
Otherwise, output from: `node --version` , `npm --version` and Angular version.
19+
-->
20+
21+
22+
### Repro steps
23+
<!--
24+
Simple steps to reproduce this bug.
25+
Please include: commands run, packages added, related code changes.
26+
A link to a sample repo would help too.
27+
-->
28+
29+
30+
### The log given by the failure
31+
<!-- Normally this include a stack trace and some more information. -->
32+
33+
34+
### Desired functionality
35+
<!--
36+
What would like to see implemented?
37+
What is the usecase?
38+
-->
39+
40+
41+
### Mention any other details that might be useful
42+
<!-- Please include a link to the repo if this is related to an OSS project. -->

README.md

+78
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
<p align="center">
2+
<img height="256px" width="256px" style="text-align: center;" src="https://cdn.rawgit.com/AnthonyNahas/@firebaseui/ng-bootstrap/master/demo/src/assets/logo.svg">
3+
</p>
4+
5+
# @firebaseui/ng-bootstrap - Angular Bootstrap UI library for firebase authentication powered by @ng-bootstrap
6+
7+
[![npm version](https://badge.fury.io/js/@firebaseui/ng-bootstrap.svg)](https://badge.fury.io/js/@firebaseui/ng-bootstrap),
8+
[![Build Status](https://travis-ci.org/AnthonyNahas/@firebaseui/ng-bootstrap.svg?branch=master)](https://travis-ci.org/AnthonyNahas/@firebaseui/ng-bootstrap)
9+
[![Coverage Status](https://coveralls.io/repos/github/AnthonyNahas/@firebaseui/ng-bootstrap/badge.svg?branch=master)](https://coveralls.io/github/AnthonyNahas/@firebaseui/ng-bootstrap?branch=master)
10+
[![dependency Status](https://david-dm.org/AnthonyNahas/@firebaseui/ng-bootstrap/status.svg)](https://david-dm.org/AnthonyNahas/@firebaseui/ng-bootstrap)
11+
[![devDependency Status](https://david-dm.org/AnthonyNahas/@firebaseui/ng-bootstrap/dev-status.svg?branch=master)](https://david-dm.org/AnthonyNahas/@firebaseui/ng-bootstrap#info=devDependencies)
12+
[![Greenkeeper Badge](https://badges.greenkeeper.io/AnthonyNahas/@firebaseui/ng-bootstrap.svg)](https://greenkeeper.io/)
13+
14+
## Demo
15+
16+
View all the directives in action at https://AnthonyNahas.github.io/@firebaseui/ng-bootstrap
17+
18+
## Dependencies
19+
* [Angular](https://angular.io) (*requires* Angular 2 or higher, tested with 2.0.0)
20+
21+
## Installation
22+
Install above dependencies via *npm*.
23+
24+
Now install `@firebaseui/ng-bootstrap` via:
25+
```shell
26+
npm install --save @firebaseui/ng-bootstrap
27+
```
28+
29+
---
30+
##### SystemJS
31+
>**Note**:If you are using `SystemJS`, you should adjust your configuration to point to the UMD bundle.
32+
In your systemjs config file, `map` needs to tell the System loader where to look for `@firebaseui/ng-bootstrap`:
33+
```js
34+
map: {
35+
'@firebaseui/ng-bootstrap': 'node_modules/@firebaseui/ng-bootstrap/bundles/@firebaseui/ng-bootstrap.umd.js',
36+
}
37+
```
38+
---
39+
40+
Once installed you need to import the main module:
41+
```js
42+
import { LibModule } from '@firebaseui/ng-bootstrap';
43+
```
44+
The only remaining part is to list the imported module in your application module. The exact method will be slightly
45+
different for the root (top-level) module for which you should end up with the code similar to (notice ` LibModule .forRoot()`):
46+
```js
47+
import { LibModule } from '@firebaseui/ng-bootstrap';
48+
49+
@NgModule({
50+
declarations: [AppComponent, ...],
51+
imports: [LibModule.forRoot(), ...],
52+
bootstrap: [AppComponent]
53+
})
54+
export class AppModule {
55+
}
56+
```
57+
58+
Other modules in your application can simply import ` LibModule `:
59+
60+
```js
61+
import { LibModule } from '@firebaseui/ng-bootstrap';
62+
63+
@NgModule({
64+
declarations: [OtherComponent, ...],
65+
imports: [LibModule, ...],
66+
})
67+
export class OtherModule {
68+
}
69+
```
70+
71+
## Usage
72+
73+
74+
75+
## License
76+
77+
Copyright (c) 2018 Anthony Nahas. Licensed under the MIT License (MIT)
78+

0 commit comments

Comments
 (0)