From 2f2ac79b97c44f8349da6a2f39592f9f3d2d4bed Mon Sep 17 00:00:00 2001 From: Daniel Roe Date: Wed, 3 Apr 2024 14:50:50 +0100 Subject: [PATCH 1/3] docs: use new `nuxi module add` command in installation --- README.md | 2 +- docs/guide/getting-started.md | 17 ++--------------- docs/nuxt/getting-started.md | 17 ++--------------- 3 files changed, 5 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index 06740596..ca9eb99a 100644 --- a/README.md +++ b/README.md @@ -90,7 +90,7 @@ You can follow the progress and future plans on [the Roadmap issue](https://gith VueFire requires the `firebase` package to be installed as well as `vuefire`: ```bash -npm install vuefire firebase +npx nuxi@latest module add vuefire ``` Check [the documentation](https://vuefire.vuejs.org/nuxt/getting-started.html) for Nuxt instructions. diff --git a/docs/guide/getting-started.md b/docs/guide/getting-started.md index 8a4a44f1..6765ef3c 100644 --- a/docs/guide/getting-started.md +++ b/docs/guide/getting-started.md @@ -5,23 +5,10 @@ Before using VueFire, make sure you have a Firebase account and a project setup ## Installation In order to get started make sure to install the latest version of `vuefire` as well as `firebase`: - -::: code-group - -```sh [pnpm] -pnpm i vuefire firebase -``` - -```sh [yarn] -yarn add vuefire firebase +```bash +npx nuxi@latest module add vuefire ``` -```sh [npm] -npm i vuefire firebase -``` - -::: - ::: warning VueFire requires Firebase JS SDK >= 9 but **is compatible with Vue 2 and Vue 3**. diff --git a/docs/nuxt/getting-started.md b/docs/nuxt/getting-started.md index caa2c2bf..5cad7e8c 100644 --- a/docs/nuxt/getting-started.md +++ b/docs/nuxt/getting-started.md @@ -3,23 +3,10 @@ VueFire comes with an official Nuxt module that automatically handles most of the hassle of setting up VueFire in your Nuxt project. ## Installation - -::: code-group - -```sh [pnpm] -pnpm install vuefire nuxt-vuefire firebase -``` - -```sh [yarn] -yarn add vuefire nuxt-vuefire firebase -``` - -```sh [npm] -npm install vuefire nuxt-vuefire firebase +```bash +npx nuxi@latest module add vuefire ``` -::: - Additionally, if you are using [SSR](https://nuxt.com/docs/api/configuration/nuxt-config/#ssr), you need to install `firebase-admin` and its peer dependencies: ::: code-group From d910d1893c3af57e5014e68098a3a52323c00617 Mon Sep 17 00:00:00 2001 From: Daniel Roe Date: Wed, 3 Apr 2024 14:52:27 +0100 Subject: [PATCH 2/3] chore: clean up --- README.md | 1 + docs/guide/getting-started.md | 1 + docs/nuxt/getting-started.md | 1 + 3 files changed, 3 insertions(+) diff --git a/README.md b/README.md index ca9eb99a..cf895ceb 100644 --- a/README.md +++ b/README.md @@ -90,6 +90,7 @@ You can follow the progress and future plans on [the Roadmap issue](https://gith VueFire requires the `firebase` package to be installed as well as `vuefire`: ```bash +npm install firebase npx nuxi@latest module add vuefire ``` diff --git a/docs/guide/getting-started.md b/docs/guide/getting-started.md index 6765ef3c..7810ee89 100644 --- a/docs/guide/getting-started.md +++ b/docs/guide/getting-started.md @@ -6,6 +6,7 @@ Before using VueFire, make sure you have a Firebase account and a project setup In order to get started make sure to install the latest version of `vuefire` as well as `firebase`: ```bash +npm i firebase npx nuxi@latest module add vuefire ``` diff --git a/docs/nuxt/getting-started.md b/docs/nuxt/getting-started.md index 5cad7e8c..4d33f888 100644 --- a/docs/nuxt/getting-started.md +++ b/docs/nuxt/getting-started.md @@ -4,6 +4,7 @@ VueFire comes with an official Nuxt module that automatically handles most of th ## Installation ```bash +npm install firebase npx nuxi@latest module add vuefire ``` From 21726582ebefe445197ce7ea54e71acf1a2623b0 Mon Sep 17 00:00:00 2001 From: Daniel Roe Date: Wed, 3 Apr 2024 14:53:32 +0100 Subject: [PATCH 3/3] chore: revert changes to other docs --- README.md | 3 +-- docs/guide/getting-started.md | 18 +++++++++++++++--- 2 files changed, 16 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index cf895ceb..06740596 100644 --- a/README.md +++ b/README.md @@ -90,8 +90,7 @@ You can follow the progress and future plans on [the Roadmap issue](https://gith VueFire requires the `firebase` package to be installed as well as `vuefire`: ```bash -npm install firebase -npx nuxi@latest module add vuefire +npm install vuefire firebase ``` Check [the documentation](https://vuefire.vuejs.org/nuxt/getting-started.html) for Nuxt instructions. diff --git a/docs/guide/getting-started.md b/docs/guide/getting-started.md index 7810ee89..8a4a44f1 100644 --- a/docs/guide/getting-started.md +++ b/docs/guide/getting-started.md @@ -5,11 +5,23 @@ Before using VueFire, make sure you have a Firebase account and a project setup ## Installation In order to get started make sure to install the latest version of `vuefire` as well as `firebase`: -```bash -npm i firebase -npx nuxi@latest module add vuefire + +::: code-group + +```sh [pnpm] +pnpm i vuefire firebase +``` + +```sh [yarn] +yarn add vuefire firebase ``` +```sh [npm] +npm i vuefire firebase +``` + +::: + ::: warning VueFire requires Firebase JS SDK >= 9 but **is compatible with Vue 2 and Vue 3**.