@nuxtjs/firebase

Easily integrate Firebase into your Nuxt project.

IMPORTANT!

ℹ️ Firebase JS SDK Version 9 Not Supported ℹ️:
This module is written for the Firebase Javascript SDK v8 and prior. It is not yet compatible with the new modular Version 9.

If you plan to use Version 9, we advise you for the time being to implement it manually as described in the following medium article.

It is currently unclear when, and if, this module will support version 9. See discussion.

Links

• 📘 Documentation
• 🔖 Release notes
• 👥 Community

Quick Setup

Make sure you are using the newest version of Nuxt and have Firebase >8.0.0 installed in your project.

yarn add firebase # OR npm i firebase

Install the module via NPM or Yarn:

yarn add @nuxtjs/firebase # OR npm i @nuxtjs/firebase

Quick Config

Add the following to your nuxt.config.js.

See all configuration options here.

modules: [
    [
      '@nuxtjs/firebase',
      {
        config: {
          apiKey: '<apiKey>',
          authDomain: '<authDomain>',
          projectId: '<projectId>',
          storageBucket: '<storageBucket>',
          messagingSenderId: '<messagingSenderId>',
          appId: '<appId>',
          measurementId: '<measurementId>'
        },
        services: {
          auth: true // Just as example. Can be any other service.
        }
      }
    ]
  ],

Quick Usage

Now you can use all Firebase services with this.$fire.auth, this.$fire.firestore, this.$fire.messaging etc. (see list here).

Example:

try {
  await this.$fire.auth.createUserWithEmailAndPassword('[e-mail]', 'test')
} catch (e) {
  handleError(e)
}

Guidelines for issues & feature requests

• Use the GitHub issue search — check if the issue or feature request has already been reported.
• Check if the issue has been fixed — try to reproduce it using the latest master or development branch in the repository.
• Isolate the problem — create a reduced test case and a live example.

A good issue shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue? What versions are you using? What would you expect to be the outcome? All these details will help people to fix any potential bugs.

If you have difficulties that are most likely not bugs or if you just have a simple questions, please ask them in the Nuxt Discord server instead.

If you're issue does not suffice these guidelinses, it migt be closed immediately.

License

MIT - Nuxt-Community - Pascal Luther