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

docs: update installation.md #955

Merged
merged 5 commits into from
Dec 19, 2024
+16 −4
Merged

docs: update installation.md #955

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c7e6e30
docs: update installation.md, @sidebase/nuxt-auth should be installed…
s0h311 Dec 8, 2024
92e6422
revert to dev dep
s0h311 Dec 15, 2024
379c333
Update docs/guide/getting-started/installation.md
phoenix-ru Dec 19, 2024
98f7aee
Update docs/guide/getting-started/installation.md
phoenix-ru Dec 19, 2024
a498537
Merge branch 'main' into main
phoenix-ru Dec 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 17 additions & 5 deletions docs/guide/getting-started/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,36 @@

You can install NuxtAuth using nuxi:

```bash
npx nuxi@latest module add sidebase-auth
::: code-group

```bash [npm]
npx nuxi module add sidebase-auth
```

```bash [pnpm]
pnpm exec nuxi module add sidebase-auth
```

```bash [yarn]
yarn dlx nuxi module add sidebase-auth
```

:::

::: details Manual installation

::: code-group

```bash [npm]
npm i -D @sidebase/nuxt-auth
npm i @sidebase/nuxt-auth
```

```bash [pnpm]
pnpm i -D @sidebase/nuxt-auth
pnpm i @sidebase/nuxt-auth
```

```bash [yarn]
yarn add --dev @sidebase/nuxt-auth
yarn add @sidebase/nuxt-auth
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please revert to the dev dependency so we can accept your other adjustment :)

Additionally - does the nuxi module add command work for you? There's #932 which reported it not functioning

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I reverted to dev dep. The nuxi module add sidebase-auth command works fine, although it installed an RC Version of @sidebase/nuxt-auth for me. I could submit an PR regarding that. It also installs it as a regular dependency, and it installs next-auth too. Which is not mentioned in the docs. Do we want to include it in the docs too?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The rc installation was a small hiccup from our side which we fixed today, it should no longer be installed as latest, thanks for noticing it as well!
next-auth is a peer dep, it would very much depend on your package manager

Copy link
Contributor Author

@s0h311 s0h311 Dec 25, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I use pnpm, and it did not install next-auth and I ran into some issues. Don't you think that it should be included in the docs anyway?

```

:::
Expand Down