Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/e-chan1007/nuxt-firebase

Firebase Integration for Nuxt(3)
https://github.com/e-chan1007/nuxt-firebase

firebase nuxt nuxt-module nuxt3 vue

Last synced: about 4 hours ago
JSON representation

Firebase Integration for Nuxt(3)

Awesome Lists containing this project

README

        

# Nuxt Firebase

[![npm version](https://badge.fury.io/js/@e-chan1007%2Fnuxt-firebase.svg)](https://badge.fury.io/js/@e-chan1007%2Fnuxt-firebase)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/0b2cc4e860eb4156ad2d61031b396307)](https://www.codacy.com/gh/e-chan1007/nuxt-firebase/dashboard?utm_source=github.com\&utm_medium=referral\&utm_content=e-chan1007/nuxt-firebase\&utm_campaign=Badge_Grade)

Integrate [Firebase](https://firebase.google.com/) with Nuxt (3)

## Install

```sh
# npm
npm install -D firebase @e-chan1007/nuxt-firebase
# yarn
yarn add -D firebase @e-chan1007/nuxt-firebase
# pnpm
pnpm add -D firebase @e-chan1007/nuxt-firebase
```

Don't forget to install `firebase`.

## Setup

1. Add this module to the Nuxt config

```ts
export default defineNuxtConfig({
modules: [
'@e-chan1007/nuxt-firebase'
],
firebase: {
// set options here...
}
})
```

2. Use in your pages, components or server routes

```vue

Hello {{ currentUser?.displayName }}!

const { currentUser } = useAuth();

```

## Development

* Run `npm run dev:prepare` to generate type stubs.
* Use `npm run dev` to start [playground](./packages/playground) in development mode.