MCPcopy
hub / github.com/vuejs/vuefire

github.com/vuejs/vuefire @1.1.2 sqlite

repository ↗ · DeepWiki ↗ · release 1.1.2 ↗
260 symbols 771 edges 103 files 19 documented · 7%
README

VueFire logo

npm package build status

Firebase for Vue made easy!

  • Works with Vue >=2.7 and Vue 3
  • Supports Composition and Options API
  • Supports Vuex, Pinia, and anything that gives you a Vue ref()
  • Built for Modular Firebase >=9 for optimal tree shaking
  • Automatically listen for changes in nested references

📚 Documentation

Help me keep working on this project 💚

Silver Sponsors

<a href="https://route4me.com" target="_blank" rel="noopener noreferrer">






  <img src="https://posva-sponsors.pages.dev/logos/route4me.png" height="42px" alt="Route Optimizer and Route Planner Software" />

  <img src="https://posva-sponsors.pages.dev/logos/prefectlogo-light.svg" height="42px" alt="Prefect" />

  <img src="https://posva-sponsors.pages.dev/logos/vuemastery-light.svg" height="42px" alt="VueMastery" />

Bronze Sponsors

<a href="https://storyblok.com" target="_blank" rel="noopener noreferrer">






  <img src="https://posva-sponsors.pages.dev/logos/storyblok.png" height="26px" alt="Storyblok" />

  <img src="https://posva-sponsors.pages.dev/logos/nuxt-light.svg" height="26px" alt="Nuxt UI Pro Templates" />

  <img src="https://avatars.githubusercontent.com/u/4183726?u=6b50a8ea16de29d2982f43c5640b1db9299ebcd1&v=4" height="26px" alt="Antony Konstantinidis" />

  <img src="https://avatars.githubusercontent.com/u/2486424?u=7b0c73ae5d090ce53bf59473094e9606fe082c59&v=4" height="26px" alt="Stanislas Ormières" />


Status

  • VueFire and Nuxt VueFire are both currently stable

Roadmap

You can follow the progress and future plans on the Roadmap issue.

Installation

VueFire requires the firebase package to be installed as well as vuefire:

npm install vuefire firebase

Check the documentation for Nuxt instructions.

Usage

Related

License

MIT

Extension points exported contracts — how you extend this code

VueFireRuntimeConfig (Interface)
* Augments the Nuxt Runtime Config with the VueFire module options.
packages/nuxt/src/module.ts
_DatabaseRefOptionsWithDefaults (Interface)
* Global defaults type override options for all database bindings. This type remove make some optional values required.
src/database/bind.ts
VueFireOptions (Interface)
(no doc)
src/index.ts
OperationsType (Interface)
(no doc)
src/shared.ts
VueFireAuthOptions (Interface)
(no doc)
src/auth/index.ts
SSRStore (Interface)
(no doc)
src/ssr/initialState.ts
UseCollectionOptions (Interface)
(no doc)
src/firestore/index.ts
VueFireAppCheckOptions (Interface)
(no doc)
src/app-check/index.ts

Core symbols most depended-on inside this repo

databaseRef
called by 43
tests/utils.ts
set
called by 32
src/shared.ts
useDocument
called by 24
src/firestore/index.ts
sleep
called by 21
tests/utils.ts
useCollection
called by 20
src/firestore/index.ts
expectType
called by 19
tests/utils.ts
useFirebaseApp
called by 15
src/app/index.ts
data
called by 14
src/shared.ts

Shape

Function 185
Interface 58
Method 15
Class 2

Languages

TypeScript100%

Modules by API surface

src/shared.ts26 symbols
tests/utils.ts22 symbols
src/firestore/bind.ts12 symbols
scripts/release.ts12 symbols
src/database/optionsApi.ts11 symbols
tests/vitest-mock-warn.ts10 symbols
src/firestore/optionsApi.ts10 symbols
packages/nuxt/src/module.ts9 symbols
src/storage/index.ts8 symbols
src/server/auth.ts8 symbols
src/auth/user.ts8 symbols
scripts/typedoc-markdown.mjs8 symbols

Dependencies from manifests, versioned

@firebase/app-types0.9.3 · 1×
@nuxt/devtools1.0.8 · 1×
@nuxt/eslint-config0.7.3 · 1×
@nuxt/kit3.14.1592 · 1×
@nuxt/module-builder0.8.4 · 1×
@nuxt/schema3.14.1592 · 1×
@nuxt/test-utils3.15.1 · 1×
@posva/lru-cache10.0.1 · 1×
@posva/prompts2.4.4 · 1×
@types/lodash-es4.17.12 · 1×
@types/node20.11.20 · 1×
@types/semver7.5.8 · 1×

For agents

$ claude mcp add vuefire \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact