# @qonsoll/firebase-services

> Service functions for Firebase

Latest version **2.0.15** (published 2021-12-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install @qonsoll/firebase-services
pnpm add @qonsoll/firebase-services
yarn add @qonsoll/firebase-services
bun add @qonsoll/firebase-services
```

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.15 |
| Published | 2021-12-05 |
| First published | 2021-08-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 30.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | qonsoll |
| Maintainers | vladbogach, slava.shamrelyuk, aleksandrgolyk, olenashevchuk, artfun00, sashka2131, rttsu, alexpassss, evgeniy.bogdanov, shudya_ |
| Keywords | react, react-native, react-hooks, firebase, services, helpers, typescript, javascript |

## Links

- npm: https://www.npmjs.com/package/@qonsoll/firebase-services
- Repository: https://github.com/qonsoll/firebase-services
- Issues: https://github.com/qonsoll/firebase-services/issues
- npm.io page: https://npm.io/package/@qonsoll/firebase-services

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 2.0.15 (latest) — 2021-12-05
- 2.0.14 — 2021-10-25
- 2.0.13 — 2021-09-18
- 2.0.12 — 2021-09-16
- 2.0.11 — 2021-09-16
- 2.0.10 — 2021-08-25
- 2.0.9 — 2021-08-17
- 2.0.8 — 2021-08-17
- 2.0.7 — 2021-08-17
- 2.0.6 — 2021-08-17
- 2.0.5 — 2021-08-15
- 2.0.4 — 2021-08-12
- 2.0.3 — 2021-08-12
- 2.0.2 — 2021-08-11
- 2.0.1 — 2021-08-11
- … 24 more at https://npm.io/package/@qonsoll/firebase-services/versions

## README

# Firebase services

> A set of reusable services functions for [Firebase](https://firebase.google.com/).

[![NPM](https://img.shields.io/npm/v/@qonsoll/firebase-services.svg)](https://www.npmjs.com/package/@qonsoll/firebase-services)
![npm bundle size](https://img.shields.io/bundlephobia/min/@qonsoll/firebase-services)
[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)


## Install

@qonsoll/firebase-services requires **React 16.8.0 or later** and **Firebase 8.8.0 <= version < 9**.

### Install dependencies

```bash
# with npm
npm install --save firebase lodash

# with yarn
yarn add firebase lodash
```

### Install library

```bash
# with npm
npm install @qonsoll/firebase-services

# with yarn
yarn add @qonsoll/firebase-services
```


## Usage

1. First you need to create function that will initialize firebase app in your project

```js
import firebase from 'firebase/app'
//Also here you can insert all nessesary firebase imports.
import 'firebase/auth'
import 'firebase/storage'
import 'firebase/database'
import 'firebase/firestore'

// Config and init firebase application.
export const initFirebaseApp = () => {
	const firebaseConfig = {
		apiKey: process.env.REACT_APP_FIREBASE_API_KEY,
		authDomain: process.env.REACT_APP_FIREBASE_AUTH_DOMAIN,
		databaseURL: process.env.REACT_APP_FIREBASE_DATABASE_URL,
		projectId: process.env.REACT_APP_FIREBASE_PROJECT_ID,
		storageBucket: process.env.REACT_APP_FIREBASE_STORAGE_BUCKET,
		messagingSenderId: process.env.REACT_APP_FIREBASE_MESSAGING_SENDER_ID,
		appId: process.env.REACT_APP_FIREBASE_APP_ID
	}
	if (!firebase.apps.length) {
		firebase.initializeApp(firebaseConfig)
	} else {
		firebase.app()
	}
}

```
2. In your index.js file import previous function and call it.

```js
//
// ...imports
//
import { initFirebaseApp } from './config/firebase'

// Initialize firebase application.
initFirebaseApp()

const App = () => (
  {/* Components */}
)
```

3. After you initialized firebase app, you should add component which will provide firebase object for library.

```js
import firebase from 'firebase/app'
// Use default import to name it as you want.
import FBSProvider from '@qonsoll/firebase-services'
// or use named import.
// import { FirebaseServicesProvider } from '@qonsoll/firebase-services'
import { initFirebaseApp } from './config/firebase'

// Initialize firebase application.
initFirebaseApp()

const App = () => ( 
  <FBSProvider firebase={firebase}>
	{/* Components */}
  </FBSProvider>
)
```

Next step is read documentation about functions you needs.

### Documentation

- [Auth services](/src/hooks/useAuthServices)
- [Cloud Firestore services](/src/hooks/useFirestoreServices)
- [Cloud Storage services](/src/hooks/useStorageServices)
- [Realtime Database services](/src/hooks/useDatabaseServices)

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