Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: use new nuxi module add command in installation #1517

Merged
merged 3 commits into from
Apr 3, 2024
Merged

docs: use new nuxi module add command in installation #1517

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2f2ac79
docs: use new `nuxi module add` command in installation
danielroe Apr 3, 2024
d910d18
chore: clean up
danielroe Apr 3, 2024
2172658
chore: revert changes to other docs
danielroe Apr 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
danielroe marked this conversation as resolved.
Show resolved Hide resolved
```

Check [the documentation](https://vuefire.vuejs.org/nuxt/getting-started.html) for Nuxt instructions.
Expand Down
17 changes: 2 additions & 15 deletions docs/guide/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
danielroe marked this conversation as resolved.
Show resolved Hide resolved
```

```sh [npm]
npm i vuefire firebase
```

:::

::: warning

VueFire requires Firebase JS SDK >= 9 but **is compatible with Vue 2 and Vue 3**.
Expand Down
17 changes: 2 additions & 15 deletions docs/nuxt/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
danielroe marked this conversation as resolved.
Show resolved Hide resolved
```

:::

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
Expand Down