Giter Club home page Giter Club logo

firebase-module's Introduction

nuxt-firebase logo

Easily integrate Firebase into your Nuxt project.

IMPORTANT!

⚠ī¸ Nuxt 3 not supported ⚠ī¸:

This module was written for Nuxt 2 and does currently not support Nuxt 3. There are currently no plans to support Nuxt 3 in the near future in this module. However, you can take a look at VueFire Nuxt module for Nuxt 3 support

ℹī¸ Modular Mode (Firebase v9+) ℹī¸:

This module does not support the new modular syntax from Firebase v9+.

If you plan to use the new modular mode of Version 9, we advise you to implement Firebase manually as described in the following medium article.

It is currently unclear when, and if, this module will support the new modular mode. See discussion.

Links

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("[email protected]", "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 your issue does not suffice these guidelines, it might be closed immediately.

License

MIT - Nuxt-Community - Pascal Luther

firebase-module's People

Contributors

lupas avatar renovate-bot avatar mental-maze avatar ricardogobbosouza avatar atinux avatar pimlie avatar fachrihawari avatar ahmedhusseinf avatar eljass avatar aaharu avatar thomorlo avatar emmanuelvlad avatar dependabot[bot] avatar alemoreau avatar tibs245 avatar binzcodes avatar hanayuki avatar lesharris avatar gkkirilov avatar 1shaked avatar jjangga0214 avatar dr3tt avatar aseidma avatar vinceglb avatar storm-technologies avatar radurentea avatar officialpiyush avatar r3volut1oner avatar nvitaterna avatar mattzahel avatar

Stargazers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤ī¸ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.