feat(playground): Demonstrate features in playground

[kheiner]

I have a branch that I've been working on in the background for the playground to be able to more robustly test/demonstrate the features of the module. With the flurry of changes in the past few weeks I'm worried it will become stale - so I'm just putting this issue here to ensure you don't do double work on the playground.

I think the only real impact will be from #50.

If the pace of development is going to keep this high, I think there should be a project board to manage the work and order the PR's that make the most sense. With a major version bump to 6, we should also prioritize #33.

[matt-rolley]

Yes, I'll look at getting a playground.nuxt-directus-sdk.rolley.io setup, with the same workflow/deploy scripts.

TBH, I think I've now roughly implemented all the features that I think should go into V6, so development should slow down, at least for a while so that we can test, get it stable etc.

I don't think they'll be much more to go into V6, but maybe a project board going forward is a good idea

[kheiner]

I don't recommend we establish a public playground, since that will involve establishing a live directus instance and exposing admin credentials to that instance. I was just going to get the play ground set up for local development/testing.

It's possible to get a directus instance in a container that resets on a cron job but that's a lot of infrastructure cost without much benefit.

[matt-rolley]

Yeah, I'm thinking of doing something like this to be honest, let me know what you think. I'm hoping the cost will be minimal, but something I'm keen to explore.

I'm going to look into a side project that can create Directus Instances (very likely time limited that gets created after a form entry) and then I'd like to have it so the playground can easily integrate into that. The end goal is for people to submit enquiries about Directus to Rolley (my agency), so maybe I'll try to bring something forward for this playground.

I'm going to put it in the Advertising budget I think, I might have to monitor it as it could get expensive haha.

[kheiner]

I did not attach PR #61 to this issue because I think there's discussion that I did not address in the request, but I'm happy with the progress I made over there.

Let me know if you have any feedback or concerns. I got a little sloppy with the stylesheet since I've been using tailwinds for so long I struggled to keep a consistent style :(.

[matt-rolley]

Looks good to me, I was going to say - I think we'll chuck nuxt ui/tailwind into this, it should help with the playground but it looks like a great start!

[matt-rolley]

Hey @kheiner - I've added Nuxt UI and Tailwind to the playground based on what you created yesterday, I've sent you an email separately (to your GitHub credentials gmail) with your admin username and password, feel free to do whatever you'd like to this, (it'll probably need the Directus schemas from one of the templates adding).

Playground URL: https://playground.nuxt-directus-sdk.rolley.io/

I've set up the admin url and token on the playground, but any issues, please let me know.

It's worth noting, the machine goes to sleep after 15 minutes of inactivity, so it could take a minute or so to wake up and a couple of refreshes for it to kick in.

[kheiner]

I got access to the playground, updated information as well as applied the cms template. I would suggest creating a 'known good state' and reset daily (at minimum) to that state since it's likely that there will need to be some permissions exposed to open credentials to make the playground meaningful to end users.

To protect ourselves between now and then I suspended the users created by the cms template so you can decide how to manage the public credentials and/or if you want to.

[kheiner]

RE: NuxtUI/Tailwinds -- perfect; I'll keep tweaking this and start creating re-usable components to make it super easy for us to keep it up to date.

[matt-rolley]

Sounds great, I'll look into a snapshotting system for the playground.

[matt-rolley]

I've just implemented a daily reset @ 04:00 UK time to the current state. I'll just keep monitoring it to see how it's getting on

[kheiner]

I'll check next week to ensure my access still works as expected.

Some things we'll want to think about off the top of my head (I'm sure there's a lot more):

• Should we create our own users with limited permissions to only function with that specific example? (I have the default users suspended right now, but the default credentials offer administrative access on the instance)
• Do we want to demonstrate SSO with signups and such? If so, we could implement SSO with GitHub since the audience for playground is developers.
• To demonstrate password reset you need a mailer attached; I use www.purelymail.com as a cheap tester - you could accidentally rack up significant charges if you don't put limits, but otherwise it's really cheap. Not sure if it's really worth the cost to do, though, even if it is cheap.

Leaving notes for future me:

• Probably worth calling out where we've customized Directus to work with our version of the playground vs what's a default option in Directus.
• Bryant Gillespie (Directus Employee) offered to help list our module with nuxt. @matt-rolley I'll take on emailing him after we get the big code cleanup stuff done and more tests implemented (unless you're wanting to email him based on the comment)
• feat(directus): add sharp transforms & key modifier nuxt/image#2207 after merge could be shown in the playground and we may be able to enlist Bryant's help with getting it attention.

[matt-rolley]

Yes, I think that's a great idea - A user that can do a comment on a blog post or something, just to demonstrate the login system woudl be great.

SSO with GitHub could be cool, I'll look into this one.

Like the Directus Hosting, Rolley is happy to sponsor the emails and use our Resend package. Again, if we get spammed then I might need to tweak some settings but should be fine for now

If I do the SSO integration and Email Provider, are you happy to setup the rest please?

[kheiner]

Of course. See here for rate limiting email to prevent spamming. https://directus.io/docs/configuration/security-limits#email-rate-limiting

[matt-rolley]

I think the emails (no-reply@nuxt-directus-sdk.com), domains (https://www.nuxt-directus-sdk.com/, https://playground.nuxt-directus-sdk.com/ and https://playground-api.nuxt-directus-sdk.com/) should now be setup.

I've set the default user to be the new user role I created. Hopefully this should all be ready for you to take over if that works? Any issues, please let me know

[matt-rolley]

Also, I've made some changes so I've created a new 'backup' state. The reset didn't trigger last night as I'd missed a config setting, so fingers crossed tonight it'll reset it.