https://github.com/backupfire/backupfire-firebase

👩‍🏭 Backup Fire Firebase agent
https://github.com/backupfire/backupfire-firebase

backup backup-fire backup-firebase-authentication backup-firebase-data backup-firebase-database backup-firebase-firestore backup-firebase-users backup-firestore backup-google-firebase firebase firebase-authentication firebase-database firebase-users firestore

Last synced: about 2 months ago
JSON representation

👩‍🏭 Backup Fire Firebase agent

• Host: GitHub
• URL: https://github.com/backupfire/backupfire-firebase
• Owner: backupfire
• License: bsd-3-clause
• Created: 2019-09-24T11:45:52.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-06-09T02:35:06.000Z (over 1 year ago)
• Last Synced: 2024-10-10T23:12:31.639Z (2 months ago)
• Topics: backup, backup-fire, backup-firebase-authentication, backup-firebase-data, backup-firebase-database, backup-firebase-firestore, backup-firebase-users, backup-firestore, backup-google-firebase, firebase, firebase-authentication, firebase-database, firebase-users, firestore
• Language: TypeScript
• Homepage: https://backupfire.dev
• Size: 3.62 MB
• Stars: 39
• Watchers: 2
• Forks: 3
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Backup Fire agent for Firebase

This is open-source core of [Backup Fire](https://backupfire.dev), a service that enables automatic backup of Firestore, the Firebase's DB, and Firebase authentication data.

**To setup automatic backups, sign up at [Backup Fire](https://backupfire.dev), create a project, and follow the provided instructions. The examples below are provided only as a reference.**

## Installation

The library is available as [an npm package](https://www.npmjs.com/package/@backupfire/firebase). To install it, run:

```bash

npm install @backupfire/firebase --save

# or with yarn

yarn add @backupfire/firebase

```

## Usage

**Make sure that you created and activated a project at [Backup Fire](https://backupfire.dev) first**.

JavaScript:

```js

// 1. Import the agent package

const backupfireAgent = require('@backupfire/firebase')

// 2. Create and export the agent

exports.backupfire = backupfireAgent()

```

TypeScript:

```ts

// 1. Import the agent package

import backupfireAgent from '@backupfire/firebase'

// 2. Create and export the agent

export const backupfire = backupfireAgent()

```

Specify the region to deploy the agent function:

```ts

import backupfireAgent from '@backupfire/firebase'

export const backupfire = backupfireAgent({

  // See the list of available regions:

  // https://firebase.google.com/docs/functions/locations

  region: 'europe-west3'

})

```

## License

[BSD 3-Clause © Backup Fire](./LICENSE.md)