@relking-elements/vue-firebase 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +118 -0
- package/dist/index.cjs +1096 -0
- package/dist/index.d.cts +605 -0
- package/dist/index.d.mts +605 -0
- package/dist/index.d.ts +605 -0
- package/dist/index.mjs +1060 -0
- package/package.json +85 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
The MIT License (MIT)
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2016-present Eduardo San Martin Morote
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<a href="https://vuefire.vuejs.org" target="_blank" rel="noopener noreferrer">
|
|
3
|
+
<img width="100" src="https://vuefire.vuejs.org/logo.svg" alt="VueFire logo">
|
|
4
|
+
</a>
|
|
5
|
+
</p>
|
|
6
|
+
<br/>
|
|
7
|
+
<p align="center">
|
|
8
|
+
<a href="https://npmjs.com/package/vuefire"><img src="https://badgen.net/npm/v/vuefire" alt="npm package"></a>
|
|
9
|
+
<a href="https://github.com/vuejs/vuefire/actions/workflows/test.yml"><img src="https://github.com/vuejs/vuefire/workflows/test/badge.svg?branch=main" alt="build status"></a>
|
|
10
|
+
<a href="https://codecov.io/gh/vuejs/vuefire"><img src="https://codecov.io/gh/vuejs/vuefire/graph/badge.svg?token=CSDk1ePUQc"/></a>
|
|
11
|
+
</p>
|
|
12
|
+
<br/>
|
|
13
|
+
|
|
14
|
+
> Firebase for Vue made easy!
|
|
15
|
+
|
|
16
|
+
- Works with Vue >=2.7 and Vue 3
|
|
17
|
+
- Supports Composition and Options API
|
|
18
|
+
- Supports Vuex, Pinia, and anything that gives you a Vue `ref()`
|
|
19
|
+
- Built for Modular Firebase >=9 for optimal tree shaking
|
|
20
|
+
- Automatically listen for changes in nested references
|
|
21
|
+
|
|
22
|
+
[**📚 Documentation**](https://vuefire.vuejs.org/)
|
|
23
|
+
|
|
24
|
+
## Help me keep working on this project 💚
|
|
25
|
+
|
|
26
|
+
- [Become a Sponsor on GitHub](https://github.com/sponsors/posva)
|
|
27
|
+
- [One-time donation via PayPal](https://paypal.me/posva)
|
|
28
|
+
|
|
29
|
+
<!--sponsors start-->
|
|
30
|
+
|
|
31
|
+
<h4 align="center">Silver Sponsors</h4>
|
|
32
|
+
<p align="center">
|
|
33
|
+
<a href="https://route4me.com" target="_blank" rel="noopener noreferrer">
|
|
34
|
+
<picture>
|
|
35
|
+
<source srcset="https://posva-sponsors.pages.dev/logos/route4me.png" media="(prefers-color-scheme: dark)" height="42px" alt="Route Optimizer and Route Planner Software" />
|
|
36
|
+
<img src="https://posva-sponsors.pages.dev/logos/route4me.png" height="42px" alt="Route Optimizer and Route Planner Software" />
|
|
37
|
+
</picture>
|
|
38
|
+
</a>
|
|
39
|
+
<a href="https://www.prefect.io/" target="_blank" rel="noopener noreferrer">
|
|
40
|
+
<picture>
|
|
41
|
+
<source srcset="https://posva-sponsors.pages.dev/logos/prefectlogo-dark.svg" media="(prefers-color-scheme: dark)" height="42px" alt="Prefect" />
|
|
42
|
+
<img src="https://posva-sponsors.pages.dev/logos/prefectlogo-light.svg" height="42px" alt="Prefect" />
|
|
43
|
+
</picture>
|
|
44
|
+
</a>
|
|
45
|
+
<a href="https://www.vuemastery.com/" target="_blank" rel="noopener noreferrer">
|
|
46
|
+
<picture>
|
|
47
|
+
<source srcset="https://posva-sponsors.pages.dev/logos/vuemastery-dark.png" media="(prefers-color-scheme: dark)" height="42px" alt="VueMastery" />
|
|
48
|
+
<img src="https://posva-sponsors.pages.dev/logos/vuemastery-light.svg" height="42px" alt="VueMastery" />
|
|
49
|
+
</picture>
|
|
50
|
+
</a>
|
|
51
|
+
</p>
|
|
52
|
+
|
|
53
|
+
<h4 align="center">Bronze Sponsors</h4>
|
|
54
|
+
<p align="center">
|
|
55
|
+
<a href="https://storyblok.com" target="_blank" rel="noopener noreferrer">
|
|
56
|
+
<picture>
|
|
57
|
+
<source srcset="https://posva-sponsors.pages.dev/logos/storyblok.png" media="(prefers-color-scheme: dark)" height="26px" alt="Storyblok" />
|
|
58
|
+
<img src="https://posva-sponsors.pages.dev/logos/storyblok.png" height="26px" alt="Storyblok" />
|
|
59
|
+
</picture>
|
|
60
|
+
</a>
|
|
61
|
+
<a href="https://ui.nuxt.com/pro" target="_blank" rel="noopener noreferrer">
|
|
62
|
+
<picture>
|
|
63
|
+
<source srcset="https://posva-sponsors.pages.dev/logos/nuxt-dark.svg" media="(prefers-color-scheme: dark)" height="26px" alt="Nuxt UI Pro Templates" />
|
|
64
|
+
<img src="https://posva-sponsors.pages.dev/logos/nuxt-light.svg" height="26px" alt="Nuxt UI Pro Templates" />
|
|
65
|
+
</picture>
|
|
66
|
+
</a>
|
|
67
|
+
<a href="https://www.vuejs.de" target="_blank" rel="noopener noreferrer">
|
|
68
|
+
<picture>
|
|
69
|
+
<source srcset="https://avatars.githubusercontent.com/u/4183726?u=6b50a8ea16de29d2982f43c5640b1db9299ebcd1&v=4" media="(prefers-color-scheme: dark)" height="26px" alt="Antony Konstantinidis" />
|
|
70
|
+
<img src="https://avatars.githubusercontent.com/u/4183726?u=6b50a8ea16de29d2982f43c5640b1db9299ebcd1&v=4" height="26px" alt="Antony Konstantinidis" />
|
|
71
|
+
</picture>
|
|
72
|
+
</a>
|
|
73
|
+
<a href="https://stormier.ninja" target="_blank" rel="noopener noreferrer">
|
|
74
|
+
<picture>
|
|
75
|
+
<source srcset="https://avatars.githubusercontent.com/u/2486424?u=7b0c73ae5d090ce53bf59473094e9606fe082c59&v=4" media="(prefers-color-scheme: dark)" height="26px" alt="Stanislas Ormières" />
|
|
76
|
+
<img src="https://avatars.githubusercontent.com/u/2486424?u=7b0c73ae5d090ce53bf59473094e9606fe082c59&v=4" height="26px" alt="Stanislas Ormières" />
|
|
77
|
+
</picture>
|
|
78
|
+
</a>
|
|
79
|
+
</p>
|
|
80
|
+
|
|
81
|
+
<!--sponsors end-->
|
|
82
|
+
|
|
83
|
+
---
|
|
84
|
+
|
|
85
|
+
## Status
|
|
86
|
+
|
|
87
|
+
- VueFire and Nuxt VueFire are both currently stable
|
|
88
|
+
|
|
89
|
+
## Roadmap
|
|
90
|
+
|
|
91
|
+
You can follow the progress and future plans on [the Roadmap issue](https://github.com/vuejs/vuefire/issues/1241).
|
|
92
|
+
|
|
93
|
+
## Installation
|
|
94
|
+
|
|
95
|
+
VueFire requires the `firebase` package to be installed as well as `vuefire`:
|
|
96
|
+
|
|
97
|
+
```bash
|
|
98
|
+
npm install vuefire firebase
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
Check [the documentation](https://vuefire.vuejs.org/nuxt/getting-started.html) for Nuxt instructions.
|
|
102
|
+
|
|
103
|
+
## Usage
|
|
104
|
+
|
|
105
|
+
- [Getting Started](https://vuefire.vuejs.org/guide/getting-started.html)
|
|
106
|
+
- [Vite Demo](https://github.com/posva/vuefire-vite-example)
|
|
107
|
+
- [Nuxt demo - Spark Plan](https://github.com/posva/nuxt--vuefire-example-spark-plan)
|
|
108
|
+
- [Nuxt demo - Blaze Plan](https://github.com/posva/nuxt--vuefire-example-blaze-plan)
|
|
109
|
+
|
|
110
|
+
## Related
|
|
111
|
+
|
|
112
|
+
- [Firebase Web Docs](https://firebase.google.com/docs/web/setup)
|
|
113
|
+
- [Realtime database](https://firebase.google.com/docs/database/)
|
|
114
|
+
- [Cloud Firestore](https://firebase.google.com/docs/firestore/)
|
|
115
|
+
|
|
116
|
+
## License
|
|
117
|
+
|
|
118
|
+
[MIT](http://opensource.org/licenses/MIT)
|