gatsby-firesource's Introduction

gatsby-firesource

Gatsby source plugin for building websites using Firestore as a data source.

Usage

Get a private key for your Firebase project.
Put that private key somewhere in your Gatsby project.
$ npm i gatsby-firesource
Configure gatsby-config.js

module.exports = {
  plugins: [
    {
      resolve: "gatsby-firesource",
      options: {
        emulator: false,
        host: "localhost:8080",
        credential: require("./firebase.json"),
        types: [
          {
            type: "Book",
            collection: "books",
            map: doc => ({
              title: doc.title,
              isbn: doc.isbn,
              author___NODE: doc.author.id
            })
          },
          {
            type: "Author",
            collection: "authors",
            map: doc => ({
              name: doc.name,
              country: doc.country,
              books___NODE: doc.books.map(book => book.id)
            })
          }
        ]
      }
    }
  ]
}

To query

{
  allBooks {
    edges {
      node {
        title
        isbn
        author {
          name
        }
      }
    }
  }
}

Configurations

Key	Description
emulator	Optional boolean param for connect your app to the Cloud Firestore Emulator. Default value `false`
host	Optional string param custom host for connect your app to the Cloud Firestore Emulator. Default value `localhost:8080`
credential	Require your private key here
types	Array of types, which require the following 3 keys
type	The type of the collection, which will be used in GraphQL queries. Eg, when `type = Book`, the GraphQL types are named `book` and `allBook`
collection	The name of the collections in Firestore. Nested collections are not tested.
map	A function to map your data in Firestore to Gatsby nodes, utilize the undocumented `___NODE` to link between nodes