search

vuejs / vuefire

🔥 Firebase bindings for Vue.js
https://vuefire.vuejs.org
MIT License
3.86k stars 333 forks source link

Improve Getting Started documentation #249

Closed pacific202 closed 5 years ago

pacific202 commented 5 years ago

I've been having a lot of difficulties getting started with vuefire in a vue-cli project. Admittedly, it's my first vue-cli project (I've built a few production apps using standalone vue), but the documentation really doesn't provide enough guidance to get started effectively.

I believe that these items are currently needed:

  1. Exactly what firebase modules are required for vuefire to work?
  2. How do you install firebase in either standalone/cdn mode or vue-cli mode?
  3. What is the recommended way to use vuefire globally in vue-cli projects?

I'm happy to help refresh the documentation once I have vuefire working in my environment and can write from experience.

posva commented 5 years ago

Check the roadmap issue :) Feedback on https://vuefire.netlify.com/ is welcome

pacific202 commented 5 years ago

Excellent, many thanks - where can I leave feedback on that netlify site?

pacific202 commented 5 years ago

For example, in the firestore setup this line is not valid syntax and the server won't compile and start with it in place:

export { TimeStamp, GeoPoint } = firebase.firestore;

posva commented 5 years ago

Yeah, export doesn't work on node code without babel or webpack. I may have forgotten the comment in that spot but I mention it's only for previous versions On Tue 2 Apr 2019 at 11:48, pacific202 notifications@github.com wrote:

For example, in the firestore setup this line is not valid syntax and the server won't compile and start with it in place:

export { TimeStamp, GeoPoint } = firebase.firestore;

Also, this line of code no longer seems necessary:

db.settings({ timestampsInSnapshots: true });

@firebase/firestore: Firestore (5.9.1): The timestampsInSnapshots setting now defaults to true and you no longer need to explicitly set it. In a future release, the setting will be removed entirely and so it is recommended that you remove it from your firestore.settings() call now.

— You are receiving this because you modified the open/close state. Reply to this email directly, view it on GitHub https://github.com/vuejs/vuefire/issues/249#issuecomment-478924410, or mute the thread https://github.com/notifications/unsubscribe-auth/AAoicV6U6aJzcwvmde6sQkKdm6b-LQNLks5vcydggaJpZM4cXYzM .

--

Eduardo San Martin Morote

pacific202 commented 5 years ago

Should I start a new thread in this repository with feedback on that site?

posva commented 5 years ago

Sure. You can create an new issue and add comments on the go and we can mark them as resolved on the go too. The export is something I will keep tho.i expect my users to know they cannot use export on nodejs On Tue 2 Apr 2019 at 14:27, pacific202 notifications@github.com wrote:

Should I start a new thread in this repository with feedback on that site?

— You are receiving this because you modified the open/close state. Reply to this email directly, view it on GitHub https://github.com/vuejs/vuefire/issues/249#issuecomment-478973043, or mute the thread https://github.com/notifications/unsubscribe-auth/AAoicZN7JbfipFPpQumPTvNCqirezfzKks5vc0zLgaJpZM4cXYzM .

--

Eduardo San Martin Morote

pacific202 commented 5 years ago

Thank you, Eduardo. Please note that I am using the Web client with vue-cli and not node.js.

posva commented 5 years ago

Maybe I missed the copy paste from one of my projects then. I thought you were referring to node somehow On Tue 2 Apr 2019 at 15:11, pacific202 notifications@github.com wrote:

Thank you, Eduardo. Please note that I am using the Web client with vue-cli and not node.js.

— You are receiving this because you modified the open/close state. Reply to this email directly, view it on GitHub https://github.com/vuejs/vuefire/issues/249#issuecomment-478988300, or mute the thread https://github.com/notifications/unsubscribe-auth/AAoicfmsYRntHC2CtEN5KYndOkzrO5Ydks5vc1bmgaJpZM4cXYzM .

--

Eduardo San Martin Morote