Skip to content

doc: fix installation instructions for tanstack-query and swr plugins #388

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

Merged
ymc9 merged 1 commit into from
Nov 17, 2024
Merged

doc: fix installation instructions for tanstack-query and swr plugins #388

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 1 addition & 2 deletions docs/quick-start/nextjs-app-router.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,8 +220,7 @@ automagically, so you don't need to write it yourself.
First install the `@zenstackhq/server`, `@tanstack/react-query`, and `@zenstackhq/tanstack-query` packages:

```bash
npm install @zenstackhq/server@latest @tanstack/react-query
npm install -D @zenstackhq/tanstack-query@latest
npm install @zenstackhq/server@latest @zenstackhq/tanstack-query@latest @tanstack/react-query
```

Let's mount it to the `/api/model/[...path]` endpoint. Create a `/src/app/api/model/[...path]/route.ts`
Expand Down
3 changes: 1 addition & 2 deletions docs/quick-start/nextjs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,8 +221,7 @@ automagically, so you don't need to write it yourself.
First install the `@zenstackhq/server`, `@tanstack/react-query`, and `@zenstackhq/tanstack-query` packages:

```bash
npm install @zenstackhq/server@latest @tanstack/react-query
npm install -D @zenstackhq/tanstack-query@latest
npm install @zenstackhq/server@latest @zenstackhq/tanstack-query@latest @tanstack/react-query
```

Let's mount it to the `/api/model/[...path]` endpoint. Create a `/src/pages/api/model/[...path].ts`
Expand Down
3 changes: 1 addition & 2 deletions docs/quick-start/nuxt.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,8 +188,7 @@ The CRUD APIs for all your models are now mounted to the `/api/model` endpoint.
We can write frontend code to consume the CRUD APIs, but that would be quite boring. Instead, let's use a plugin to generate them for us. First, install the `@zenstackhq/tanstack-query` plugin package:

```bash
npm install @tanstack/vue-query --force
npm install -D @zenstackhq/tanstack-query
npm install @zenstackhq/tanstack-query @tanstack/vue-query
```

:::info
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/plugins/swr.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ To use the generated hooks, you need to install "swr" version 2.0.0 or above.
### Installation

```bash
npm install --save-dev @zenstackhq/swr
npm install @zenstackhq/swr
```

### Context Provider
Expand Down