# adonis-firebase-sdk

> Firebase SDK for AdonisJS

Latest version **1.0.2** (published 2017-06-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install adonis-firebase-sdk
pnpm add adonis-firebase-sdk
yarn add adonis-firebase-sdk
bun add adonis-firebase-sdk
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2017-06-17 |
| First published | 2017-06-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 4 |
| Author | CodeDigest |
| Maintainers | codedigest |
| Keywords | AdonisJS, Firebase, SDK |

## Links

- npm: https://www.npmjs.com/package/adonis-firebase-sdk
- Repository: https://github.com/CodeDigest/adonis-firebase-sdk
- Homepage: https://github.com/CodeDigest/adonis-firebase-sdk#readme
- Issues: https://github.com/CodeDigest/adonis-firebase-sdk/issues
- npm.io page: https://npm.io/package/adonis-firebase-sdk

## Dependencies (1)

- [firebase](https://npm.io/package/firebase.md) ^4.1.2

## Recent versions

- 1.0.2 (latest) — 2017-06-17
- 1.0.1 — 2017-06-17
- 1.0.0 — 2017-06-17

## README

# adonis-firebase-sdk

JavaScript Firebase SDK wrapper for Adonis JS

## Install

```bash
npm install adonis-firebase-sdk --save
```

## Usage

Create a file in `app/config/firebase.js` and paste the code below by replacing it's values where necessary:

```javascript
'use strict'

/*
 |--------------------------------------------------------------------------
 | Firebase
 |--------------------------------------------------------------------------
 |
 | Provide details of firebase project
 |
 */

module.exports = {

  /*
   |--------------------------------------------------------------------------
   | API key
   |--------------------------------------------------------------------------
   */
  apiKey: "",
  /*
   |--------------------------------------------------------------------------
   | Auth
   |--------------------------------------------------------------------------
   */
  authDomain: "",
  /*
   |--------------------------------------------------------------------------
   | Database
   |--------------------------------------------------------------------------
   */
  databaseURL: "",
  /*
   |--------------------------------------------------------------------------
   | Hosting
   |--------------------------------------------------------------------------
   */
  storageBucket: ""

}
```

Also you need to add the provider to AdonisJS at `app/bootstrap/app.js`:

```javascript
const providers = [
   ...
   'adonis-firebase-sdk/providers/FirebaseProvider'
]
```

then you can simply call it from within controllers etc:

```javascript
const Firebase = use('Firebase')
`````

---
_Source: https://npm.io/package/adonis-firebase-sdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._