Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/n6g7/firebase-backup

A set of firebase functions to backup realtime db / firestore data.
https://github.com/n6g7/firebase-backup

backup firebase firebase-realtime-database firebase-storage firestore

Last synced: about 1 month ago
JSON representation

A set of firebase functions to backup realtime db / firestore data.

Awesome Lists containing this project

README

        

# firebase-backup

[![CircleCI](https://circleci.com/gh/n6g7/firebase-backup.svg?style=svg)](https://circleci.com/gh/n6g7/firebase-backup)
[![npm version](https://badge.fury.io/js/firebase-backup.svg)](https://badge.fury.io/js/firebase-backup)
[![Known Vulnerabilities](https://snyk.io/test/github/n6g7/firebase-backup/badge.svg?targetFile=package.json)](https://snyk.io/test/github/n6g7/firebase-backup?targetFile=package.json)

Firebase functions to backup realtime and firestore databases.
Backup files are stored in firebase storage.

## Usage

- Install in your functions directory:
```sh
cd ./functions
npm install firebase-backup --save
```
- Register a new function in `functions/index.js`:
```js
const backup = require('firebase-backup')

exports.backup = backup.realtimeDb()
```

## To do

- [X] Support firestore
- [ ] Support other types of functions (pubsub, ...?)
- [ ] Option: only backup a subsection of the database (selector)
- [ ] Option: custom path for backup file
- [ ] Option: compress backup file