nuxt-auth icon indicating copy to clipboard operation
nuxt-auth copied to clipboard

Create Stackblitz repros with nuxt-auth installed

Open TheDutchCoder opened this issue 1 year ago • 7 comments

Describe the feature

People probably don't want to go through the manual process of installing nuxt-auth to create reproductions. I think you should provide them with a starter.

How would you implement this?

Give people a Stackblitz starter with nuxt-auth preinstalled

Additional information

  • [X] Would you be willing to help implement this feature?

Provider

  • [ ] AuthJS
  • [ ] Local
  • [ ] Refresh
  • [ ] New Provider

TheDutchCoder avatar Jul 11 '24 12:07 TheDutchCoder

@TheDutchCoder you can import their repo demo directly on Stackblitz Here's an example https://stackblitz.com/~/github.com/sidebase/nuxt-auth-example

victorlmneves avatar Jul 12 '24 09:07 victorlmneves

Hi @TheDutchCoder 👋

As @victorlmneves mentioned, we do have the https://github.com/sidebase/nuxt-auth-example/, however we have noticed that even with just one starter, it becomes very had to always ensure it is properly maintained. I think creating multiple Stackblitz starters would make this even harder and potentially lead to outdated starters.

We also maintain an interactive CLI to bootstrap Nuxt3 projects named create-sidebase, which allows you to bootstrap a Nuxt3 project with a selection of pre-configured modules. NuxtAuth is one of them and gets added with a basic setup.

We also just released a big update to our docs (where we rewrote everything), which should hopefully make getting started easier! https://auth.sidebase.io

zoey-kaiser avatar Jul 12 '24 15:07 zoey-kaiser

Hi @zoey-kaiser

I understand the concern around maintenance, but I do feel like it's the minimum a project can do if they really want/expect users to provide reproductions for issues they find.

It's quite the hassle to set everything up from scratch so in my opinion it's worth providing at least the starter as a base for people to create repros with when they try to file a bug.

Not everyone wants to create repros locally all the time.

I hope the team reconsiders 😉

TheDutchCoder avatar Jul 12 '24 16:07 TheDutchCoder

Hi @TheDutchCoder,

I completely understand that. Maybe looking a bit forward, what kinds of starters would help create reproductions? My initial thoughts would be to have a minimum of 3 ready-to-go starters for:

  • authjs provider (maybe with a configured credentials flow?)
  • local provider (with build in Nuxt 3 "demo" backend. A bit like the playground here)
  • refresh provider (also with a pre-built Nuxt 3 backend from its playground here)

Maybe a potential solution would be to find a way to create starters from the plagrounds and update them automatically? Would this already help in your opinion?

zoey-kaiser avatar Jul 13 '24 08:07 zoey-kaiser

Hi @TheDutchCoder 👋

I took some time and created some new starters for NuxtAuth. The goal is to have them also replace the current NuxtAuth example app.

You can find two smaller starters (local and authjs with github setup) here: https://github.com/zoey-kaiser/nuxt-auth-starters/tree/main

I have to see how much time I can dedicate to adding more / maintaining them (or if we migrate them into the mono-repo). I hope these are a good starting point for now at least 🥳

Screenshot 2024-07-21 at 00 37 22

zoey-kaiser avatar Jul 20 '24 22:07 zoey-kaiser

@zoey-kaiser That's great, thank you!

Any option to have them linked in the new bug flow? Ideally as Stackblitz links so people can immediately start a repro from that flow?

TheDutchCoder avatar Jul 22 '24 11:07 TheDutchCoder

Any option to have them linked in the new bug flow? Ideally as Stackblitz links so people can immediately start a repro from that flow?

As I created these starters reasonably quickly, I am unsure if I feel confident enough to make them "official" yet. At the least, I would like to get them deployed and working as our official examples. Then I would also transfer the repository to the sidebase org.

I am also debating creating a "clone" of https://github.com/sidebase/create-sidebase that only handles creating NuxtAuth starter projects. The CLI would then allow you to close from a set of pre-defined NuxtAuth setups to get started quickly (we could also integrate this directly into create-sidebase).

I will keep this issue on my radar, but I would not close it or see it as completed yet, as there is still some work to do. However, I want to shift my focus to the 1.0.0 release as it is highly awaited and also makes a lot of breaking changes that would make the starters outdated again.

zoey-kaiser avatar Jul 22 '24 11:07 zoey-kaiser