You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-5Lines changed: 15 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -6,11 +6,21 @@
6
6
7
7
## Introduction
8
8
9
-
Firebase provides two solutions to handle real-time databases: Realtime Database and Cloud Store (which is also a realtime database).
10
-
In order to keep all clients data in-sync with its cloud database, their [js SDK](https://firebase.google.com/docs/firestore/quickstart) provides the tools to do so. However, it quickly becomes bothersome to _bind_ multiple documents or collections to your application, keep them synchronized as well as handling [references](https://firebase.google.com/docs/firestore/manage-data/data-types) to other documents or collections, which can contain references themselves and must also be kept up to date.
11
-
The goal of vuefire and vuexfire is to make this as simple as a function call that returns a promise so it is also easy to setup SSR and allows you to focus on developing your application.
12
-
13
-
To better understand why Vuefire will make it so much easier to develop Vue apps with firebase, please, check [this link in the documentation](https://vuefire.vuejs.org/vuefire/#why)
9
+
Firebase provides two solutions to handle real-time databases: Realtime Database
10
+
and Cloud Store (which is also a realtime database). In order to keep all
11
+
clients data in-sync with its cloud database, their [js
12
+
SDK](https://firebase.google.com/docs/firestore/quickstart) provides the tools
13
+
to do so. However, it quickly becomes bothersome to _bind_ multiple documents or
14
+
collections to your application, keep them synchronized as well as handling
Copy file name to clipboardExpand all lines: packages/documentation/docs/vuexfire/upgrading-from-v2.md
+19-7Lines changed: 19 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,19 @@
1
1
# Upgrading from Vuexfire v2.x to v3.0
2
2
3
-
The v2 of Vuexfire removed support of the _RTDB_ and added _Firestore_ support instead. In v3, you can use both. Because of that there were some breaking changes during alpha releases and some of the names of the exports have changed.
3
+
The v2 of Vuexfire removed support of the _RTDB_ and added _Firestore_ support
4
+
instead. In v3, you can use both. Because of that there were some breaking
5
+
changes during alpha releases and some of the names of the exports have changed.
4
6
5
-
If you partially followed, the best place to check for the few breaking changes is [the changelog](https://github.com/vuejs/vuefire/blob/master/CHANGELOG.md)
7
+
If you partially followed, the best place to check for the few breaking changes
8
+
is [the changelog](https://github.com/vuejs/vuefire/blob/master/CHANGELOG.md)
6
9
7
-
If you didn't follow during the alpha releases, **no worries**, you can easily catch up and use the latest version of Vuexfire. Follow ahead!
10
+
If you didn't follow during the alpha releases, **no worries**, you can easily
11
+
catch up and use the latest version of Vuexfire. Follow ahead!
8
12
9
13
## Renamed imports
10
14
11
-
To reflect better that mutations are the same for both _RTDB_ and _Firestore_, they have been renamed to `vuexfireMutations`:
15
+
To reflect better that mutations are the same for both _RTDB_ and _Firestore_,
16
+
they have been renamed to `vuexfireMutations`:
12
17
13
18
```diff
14
19
import Vuex from 'vuex'
@@ -24,7 +29,11 @@ const store = new Vuex.Store({
24
29
})
25
30
```
26
31
27
-
`firebaseAction` as well as the injected functions `bindFirebaseRef`/`unbindFirebaseRef` have also been renamed! But because we also support `RTDB`, `firebaseAction` still exists but is meant to be used with _RTDB_ references. If you are migrating from v2, you were likely using _Firestore_, so you should apply these modifications:
32
+
`firebaseAction` as well as the injected functions
33
+
`bindFirebaseRef`/`unbindFirebaseRef` have also been renamed! But because we
34
+
also support `RTDB`, `firebaseAction` still exists but is meant to be used with
35
+
_RTDB_ references. If you are migrating from v2, you were likely using
36
+
_Firestore_, so you should apply these modifications:
28
37
29
38
```diff
30
39
- import { firebaseAction } from 'vuexfire'
@@ -41,6 +50,9 @@ const store = new Vuex.Store({
41
50
})
42
51
```
43
52
44
-
🎉 That's it! Your app should be running again! If you found things missing in this small guide, feel free to open an Issue or a Pull Request [on Github](https://github.com/vuejs/vuefire)
53
+
🎉 That's it! Your app should be running again! If you found things missing in
54
+
this small guide, feel free to open an Issue or a Pull Request [on
55
+
Github](https://github.com/vuejs/vuefire)
45
56
46
-
You should checkout [the guide](./), there are a few code snippets that may come in handy! You can also use the _RTDB_ alongside _Firestore_ now.
57
+
You should checkout [the guide](./), there are a few code snippets that may come
58
+
in handy! You can also use the _RTDB_ alongside _Firestore_ now.
0 commit comments