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

doc: implemented Appwrite auth functionalities with Vuejs #301

Conversation

Vaibhav91one
Copy link

What does this PR do?

This PR provides a tutorial for how to use appwrite authentication with Vue

Test Plan

I have made the app while creating the tutorial.

Related PRs and Issues

Have you read the Contributing Guidelines on issues?

Yes

@vercel
Copy link

vercel bot commented Oct 30, 2023

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

Name Status Preview Comments Updated (UTC)
website ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 7, 2023 7:06am

Copy link
Contributor

@gewenyu99 gewenyu99 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, why are you removing the vue js tutorial?

@gewenyu99
Copy link
Contributor

Please also fix your build before re-requesting review. Do a pnpm run build

Thanks!

@Vaibhav91one
Copy link
Author

Sorry, why are you removing the vue js tutorial?

Should I make another folder for the vue-auth?

@Vaibhav91one
Copy link
Author

Please also fix your build before re-requesting review. Do a pnpm run build

Thanks!

Okay will do.

@gewenyu99
Copy link
Contributor

Sorry, why are you removing the vue js tutorial?

Should I make another folder for the vue-auth?

Yes, follow the convention here: https://appwrite.io/docs/tutorials/sveltekit-auth/step-1

Still hidden for now, but should be basically like this.

@Vaibhav91one
Copy link
Author

Sorry, why are you removing the vue js tutorial?

Should I make another folder for the vue-auth?

Yes, follow the convention here: https://appwrite.io/docs/tutorials/sveltekit-auth/step-1

Still hidden for now, but should be basically like this.

Okay on it.

@Vaibhav91one
Copy link
Author

Hey @gewenyu99 I seem to be getting a parse error when building for a specific code snippet
image

and when I remove that code snippet, the following error comes up:
image

@gewenyu99
Copy link
Contributor

and when I remove that code snippet, the following error comes up:

Make sure you build on your local machine, code spaces will run out of space :P

@Vaibhav91one
Copy link
Author

and when I remove that code snippet, the following error comes up:

Make sure you build on your local machine, code spaces will run out of space :P

Okay, I am building on my local machine only, will try once again.

@Vaibhav91one
Copy link
Author

@gewenyu99 I have done some changes and successful build the project. I have made another folder vue-auth and kept the vue tutorial as it is back to the project.

@gewenyu99 gewenyu99 added documentation Improvements or additions to documentation hacktoberfest-accepted labels Oct 31, 2023
@gewenyu99
Copy link
Contributor

@Vaibhav91one Thank you, it's the last day of Hacktoberfest, I'm gonna tentatively mark this Hacktoberfest accepted so you get credits from DO.

I'll review and continue to work with you on this PR, and when it's merged, you'll get contacted for swags :)

difficulty: medium
readtime: 40
---
## Appwrite: The backend you'll never have to build or maintain.
Copy link
Contributor

@gewenyu99 gewenyu99 Oct 31, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please follow convention from other published tutorials for what should be in this first page.

I understand you followed the auth deep dive we have, but that is still a draft. This page should be more similar to /tutorials/sveltekit

title: Authentication with Vue
description: Add Authentication to a Vue project using Appwrite.
step: 1
difficulty: medium
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
difficulty: medium
difficulty: intermediate

Copy link
Contributor

@gewenyu99 gewenyu99 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey, this is a great start.

Before I go in with more reviews, we really care about consistency, and this tutorial's structure is unnecessarily different from what we have in svelte kit.

Screenshot 2023-10-31 at 10 25 39 AM

I like that you also implemented password recovery and verification + protected routes.

They should be further headings:

  • Password recovery
  • User verification
  • Protected routes.

So your headings should be:

  • Authentication with SvelteKit
  • Create project
  • Initialize SDK
  • Check if logged in
  • Create login page
  • Create signup page
  • Password recovery
  • User verification
  • Protected routes
  • All set

---


You can create a Vue project using [Vue](https://vuejs.org/guide/quick-start.html).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing headings


After running all these commands, you will be able to access you Vue app.

## Adding Appwrite to Your Vue App
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Headings should be sentence case.

Missing {% #id %} tags

step: 3
---

# Create project {% #create-project %}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we just reuse step 2-3 from the vue tutorial. They don't need to be different other than description.


# Auth store {% #auth-store %}

Since, we chose pinia for state management during the installatin process.So, we have already setuped our store.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Since, we chose pinia for state management during the installatin process.So, we have already setuped our store.
Since, we chose pinia for state management during the installatin process. So, we have already setuped our store.

@Vaibhav91one
Copy link
Author

@gewenyu99 Okay will do the changes in the morning and Thank you for considering it for hacktoberfest.
(Good night🌙)

@gewenyu99
Copy link
Contributor

Hey,

Due to time constraints, I'm going to mark this PR hacktoberfest-accepted for now so you get DO's Hacktoberfest rewards. We'll continue to work with you on this issue for review and merge.

When it is merged, we'll contact you for Appwrite-specific Hacktoberfest swag.

Thanks for helping us improve Appwrite!

@tessamero tessamero linked an issue Nov 2, 2023 that may be closed by this pull request
2 tasks
@Vaibhav91one
Copy link
Author

Vaibhav91one commented Nov 7, 2023

@gewenyu99 I have made the changes.

  1. Corrections
  2. Steps added as told

(Thank you for waiting 🤗, Placement season 🥲🤞)

@gewenyu99
Copy link
Contributor

Hey, looks like a good start for the tutorial. I'll merge this into a branch to continue working on this on our end. Thank you so much!

@gewenyu99 gewenyu99 changed the base branch from main to feat-add-vue-authentication-deepdive November 17, 2023 22:02
@gewenyu99 gewenyu99 merged commit c617f94 into appwrite:feat-add-vue-authentication-deepdive Nov 17, 2023
1 check passed
@Vaibhav91one
Copy link
Author

Hey, looks like a good start for the tutorial. I'll merge this into a branch to continue working on this on our end. Thank you so much!

Your welcome and Thank you for the guidance. 🚀

@Vaibhav91one
Copy link
Author

Hey @gewenyu99 I was just curious that, is this still under review? If there is anything I can do to help, feel free to ask.

@gewenyu99
Copy link
Contributor

Hey there! There were a lot of big PRs during this Hacktoberfest, and we wanted to give everyone ample time to collaborate with our engineering team. If you were able to merge your PRs during October, amazing. If it’s still not merged, don’t worry about it either. Either way, we’ve got your Hacktoberfest swag minted and ready to ship.

Please comment with your Discord username here so we can contact you about your shipping information to deliver your Hacktoberfest swag.

@Vaibhav91one
Copy link
Author

Hey there! There were a lot of big PRs during this Hacktoberfest, and we wanted to give everyone ample time to collaborate with our engineering team. If you were able to merge your PRs during October, amazing. If it’s still not merged, don’t worry about it either. Either way, we’ve got your Hacktoberfest swag minted and ready to ship.

Please comment with your Discord username here so we can contact you about your shipping information to deliver your Hacktoberfest swag.

Profile Link: https://discordapp.com/users/762914716652797982
Username: averagevaibhav

@gewenyu99
Copy link
Contributor

Will reach out soon. Appreciate your patience!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation hacktoberfest-accepted
Projects
None yet
Development

Successfully merging this pull request may close these issues.

📚 Documentation: Deep dive authentication recipe with Vue
2 participants