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.

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: added trpc-nuxt configuration section #201

Merged
merged 2 commits into from
Sep 5, 2023

Conversation

kouts
Copy link
Contributor

@kouts kouts commented Sep 3, 2023

Types of changes

  • Bug fix (a non-breaking change which fixes an issue)
  • New feature (a non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation addition

Description

This PR adds a section for trpc-nuxt, specifically on how to make the CSRF functionality work.

Checklist:

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes (if not applicable, please state why)

@vercel
Copy link

vercel bot commented Sep 3, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
nuxt-security ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 5, 2023 6:49am

@kouts
Copy link
Contributor Author

kouts commented Sep 3, 2023

Hey @Baroshem thanks for this wonderful Nuxt module.
I recently needed to enable the CSRF protection functionality to my trpc-nuxt enabled app and I couldn't find any related documentation. Hopefully this will help others looking for the same thing.

@Baroshem
Copy link
Collaborator

Baroshem commented Sep 5, 2023

Hey @kouts

Thanks for this PR! I can for sure see use cases for that. Kudos for documenting that.

One thing that I wanted to mention before merging. Could you please also add a note in this docs section about what would be the use case for having trpc with csrf (nuxt-security)? I understand clearly from the docs you written how to implement that but this docs section would benefit a lot from having a clear explanation why someone would want to use it for example:

Using trpc with carf comes with a useful advantage X that will help you achieve Y

Let me jnow what you think about it :)

@kouts
Copy link
Contributor Author

kouts commented Sep 5, 2023

Hey @Baroshem thanks, I've added a relevant section with 4333304, feel free to make any changes.

@Baroshem
Copy link
Collaborator

Baroshem commented Sep 5, 2023

@kouts

Now it looks much better! Thank you!

I will merge it and update the documentation :)

@Baroshem Baroshem merged commit ea31a62 into nuxt-modules:main Sep 5, 2023
2 checks passed
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.

2 participants