README

GrapesJS Firestore

Fork of GrapesJS storage wrapper for Cloud Firestore, flexible, scalable NoSQL cloud database to store and sync data for client/server-side development.

Uses Firestore update method instead of set method for updating documents.

Requires GrapesJS v0.14.15 or higher

Summary

Plugin name: grapesjs-firestore-update
Storage
- firestore

Options

|Option|Description|Default| |-|-|- | apiKey | Firebase API key | '' | | authDomain | Firebase Auth domain | '' | | projectId | Cloud Firestore project ID | '' | | docId | Document id | 'gjs' | | collectionName | Collection name | 'templates' | | enableOffline | Enable support for offline data persistence | true | | settings | Firestore database settings | { timestampsInSnapshots: true } |

Download

NPM
- npm i grapesjs-firestore-update

Usage

Before start using this plugin you have to create and enable Cloud Firestore project in Firebase Console. When you create a Firestore project, it also enables its API, which you can get from Cloud API Manager.

<link href="https://unpkg.com/grapesjs/dist/css/grapes.min.css" rel="stylesheet"/>
<script src="https://unpkg.com/grapesjs"></script>
<script src="path/to/grapesjs-firestore-update.min.js"></script>

<script src="https://www.gstatic.com/firebasejs/4.13.0/firebase.js"></script>
<script src="https://www.gstatic.com/firebasejs/4.13.0/firebase-firestore.js"></script>

<div id="gjs"></div>

<script type="text/javascript">
  var editor = grapesjs.init({
      container : '#gjs',
      ...
      storageManager: { type: 'firestore' },
      plugins: ['grapesjs-firestore'],
      pluginsOpts: {
        'grapesjs-firestore': {
          docId: 'someID',
          apiKey: '<API_KEY>',
          authDomain: '<PROJECT_ID>.firebaseapp.com',
          projectId: '<PROJECT_ID>',
        }
      }
  });
</script>

By default, Firebase allows everyone to read/write data inside your DB by knowing the API credentials, which is ok for the first setup and development but, obviously, not for production. To get more about the Firestore security checkout this guide.

Development

Clone the repository

$ git clone https://github.com/PaulEvers/grapesjs-firestore
$ cd grapesjs-firestore-update

Install dependencies

$ npm i

The plugin relies on GrapesJS via peerDependencies so you have to install it manually (without adding it to package.json)

$ npm i grapesjs --no-save

Start the dev server

$ npm start

License

BSD 3-Clause

Usage no npm install needed!