Skip to content

feat: nuxt quickstart docs #125

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.

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Conversation

J-boardman
Copy link

Adds quickstart and client library documentation for the Nuxt Integration.

Hoping to give it more visibility!


By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@taowang1993
Copy link

+1

@nipunn1313
Copy link
Collaborator

@ikhare want to take a look?

Thanks for the contribution!

@nipunn1313 nipunn1313 requested a review from ikhare July 7, 2025 22:27
@ikhare
Copy link
Contributor

ikhare commented Jul 7, 2025

I'm down to have a Nuxt quickstart. Tagging in @thomasballinger since he's done some Vue wrangling before.

@thomasballinger
Copy link
Contributor

All for it! A few things to do first.

We should also move over to recommending https://github.com/chris-visser/convex-vue instead of https://github.com/Darialyphia/convex-vue if we add docs for this, it'll be confusing to have two similar libraries and quickstarts for each. I'm all for it if @chris-visser doesn't mind.

I haven't used this library, @J-boardman have you? Does it work for you, are there any hosted examples anywhere? Even better, is there anyone using this library on a production site?

@Darialyphia heads up, based on the contribution history of these libraries this feels like the reasonable change to make but want to check in if you have thoughts, or feel free to email me at [email protected].

@J-boardman
Copy link
Author

All for it! A few things to do first.

We should also move over to recommending chris-visser/convex-vue instead of Darialyphia/convex-vue if we add docs for this, it'll be confusing to have two similar libraries and quickstarts for each. I'm all for it if @chris-visser doesn't mind.

I haven't used this library, @J-boardman have you? Does it work for you, are there any hosted examples anywhere? Even better, is there anyone using this library on a production site?

@Darialyphia heads up, based on the contribution history of these libraries this feels like the reasonable change to make but want to check in if you have thoughts, or feel free to email me at [email protected].

Yeah very keen to have some consistency between the Vue / Nuxt quickstart guides, just didn't want to step on any toes by suggesting it without permission!

I have played around with it, and currently waiting for paginated queries (currently on the roadmap) before I start contributing myself to some component bindings. Would have to defer to @chris-visser for any more details regarding usage. But I'm more than happy to get something deployed over the next few weeks to try demonstrate it's validity!

@thomasballinger
Copy link
Contributor

Cool, once we get confirmation that Chris is ok with this let's do it.

Re pagination let's talk, ideally we can build an abstraction that works across frameworks, possibly taking the code from usePaginatedQuery and moving the un-Reactified version to a stateful object that the BaseConvexClient handles

@chris-visser
Copy link

chris-visser commented Jul 8, 2025

Hey. Not sure though why its pointing to a different nuxt integration package? We are collaborating and making a successful nuxt integration with on https://github.com/chris-visser/convex-nuxt. Should that doc then refer to this repo?

@chris-visser
Copy link

Cool, once we get confirmation that Chris is ok with this let's do it.

Re pagination let's talk, ideally we can build an abstraction that works across frameworks, possibly taking the code from usePaginatedQuery and moving the un-Reactified version to a stateful object that the BaseConvexClient handles

A safe bet would be to use the alien-signals (https://github.com/stackblitz/alien-signals) library to build a reactive layer on top of the Convex client. From there its easily extended into framework specific implementations. Vue and other frameworks are essentially using alien signals adapters (presented on VueJS Amsterdam this year by Evan You.

@chris-visser
Copy link

I haven't used this library, @J-boardman have you? Does it work for you, are there any hosted examples anywhere? Even better, is there anyone using this library on a production site?

Not yet in production. I'm building a big project with my team using convex-vue and convex-nuxt. We are adding features to convex-vue and convex-nuxt as part of building this platform.

@J-boardman
Copy link
Author

Hey. Not sure though why its pointing to a different nuxt integration package? We are collaborating and making a successful nuxt integration with on https://github.com/chris-visser/convex-nuxt. Should that doc then refer to this repo?

Ah yep, my apologies, time to un-bookmark the other repo!

Will switch that and the Vue links over asap

- Updated Vue quickstart to point to `convex-vue` package instead of `@convex-vue/core`
- Updated Vue quickstart repository to use new package
- Updated Nuxt quickstart guide to more accurately reflect setup process
- Added example Nuxt + Convex application to private-demos/quickstarts
@J-boardman
Copy link
Author

@thomasballinger @chris-visser

Vue & Nuxt docs should now all be pointing to the right repos / npm pages!

I haven't used this library, @J-boardman have you? Does it work for you, are there any hosted examples anywhere? Even better, is there anyone using this library on a production site?

Hosted example coming soon™

@taowang1993
Copy link

Hi, I want to use Nuxt.js for the Convex and Resend Hackthon. Is this PR ready to be used in production. Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants