# @hadx/firebase

> @hadx/firebase

Latest version **0.0.5** (published 2020-03-03) · ISC license · 0 weekly downloads

## Install

```sh
npm install @hadx/firebase
pnpm add @hadx/firebase
yarn add @hadx/firebase
bun add @hadx/firebase
```

## Health

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

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

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.5 |
| Published | 2020-03-03 |
| First published | 2020-03-02 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 5.9 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Arthur Dao |
| Maintainers | newbiebr |

## Links

- npm: https://www.npmjs.com/package/@hadx/firebase
- Repository: https://github.com/NewBieBR/hadex-firebase
- Homepage: https://github.com/NewBieBR/hadex-firebase#readme
- Issues: https://github.com/NewBieBRhadex-firebase/issues
- npm.io page: https://npm.io/package/@hadx/firebase

## Dependencies (1)

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

## Recent versions

- 0.0.5 (latest) — 2020-03-03
- 0.0.4 — 2020-03-02
- 0.0.3 — 2020-03-02
- 0.0.2 — 2020-03-02
- 0.0.1 — 2020-03-02

## README

# Hadex Firebase


## Getting started

1. Create a new project on [firebase console](https://console.firebase.google.com) (ex: MyApp)

2. Create Firestore database with `Rules`

```
rules_version = '2';
service cloud.firestore {
  match /databases/{database}/documents {
    match /{document=**} {
      allow read, write: if request.auth != null;
    }
  }
}
```
3. Enable Email/Password Authentication and add a new user, note down the email and password
4. Install this package
```bash
yarn add @hadx/firebase
```
5. Add a Web App to the project

<img src="./assets/addAnApp.png" height="300" >

6. Copy and save the firebaseConfig part to your code

<img src="./assets/getConfigs.png" height="300" >


## Usage

```ts
import Firebase from '@hadx/firebase';

const auth = {email: ..., password: ...} // create above (step 3)
const config = {...}; // copied above (step 6)
Firebase.initialize(config, auth, 'myApp');
```

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