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

📚 Documentation: Deep dive authentication recipe with Vue #90

Open
2 tasks done
gewenyu99 opened this issue Sep 27, 2023 · 26 comments · Fixed by #301
Open
2 tasks done

📚 Documentation: Deep dive authentication recipe with Vue #90

gewenyu99 opened this issue Sep 27, 2023 · 26 comments · Fixed by #301
Assignees
Labels
documentation Improvements or additions to documentation hacktoberfest

Comments

@gewenyu99
Copy link
Contributor

gewenyu99 commented Sep 27, 2023

💭 Description

Goal

Deep dive tutorial for beginners to learn Appwrite Authentication in depth with Vue.

Content

  1. The end product should be a functional app with auth screens.
  2. Step by step from setup. If there will be test data, provide a Server SDK script with instructions.
  3. Format should be similar to /docs/tutorials/sveltekit
  4. Should contain the following content similar to this PR
    1. Sign up
    2. Log in
    3. Verification
    4. Recovery
    5. Conditional routing based on auth state
    6. Preferences
    7. Delete account

How to contribute

Pitch an outline detailing each page you plan to add and headings within, and ask to be assigned. Open a PR after the outline has been approved.

The Appwrite team will collaborate with you on the outline and PR.

Thanks for taking the time to make our documentation better 🙏

👀 Have you spent some time to check if this issue has been raised before?

  • I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

@gewenyu99 gewenyu99 added the documentation Improvements or additions to documentation label Sep 27, 2023
@ayan-joshi
Copy link

I want to work on this issue , Can you please assign this to me @Haimantika @gewenyu99

@Haimantika
Copy link
Contributor

I want to work on this issue , Can you please assign this to me @Haimantika @gewenyu99

Hi @ayan-joshi have assigned the issue to you! Thank you for showing interest in contributing to Appwrite! Happy Hacktoberfest 🎃

Notes:

Please update us with your progress every 3 days, so that we know that you are working on it.
Join us on Discord - https://appwrite.io/discord to chat about Hacktoberfest and Appwrite!

@Haimantika
Copy link
Contributor

I want to work on this issue , Can you please assign this to me @Haimantika @gewenyu99

Hi @ayan-joshi I am unassigning you from this issue, as I have already assigned you two issues. This will leave room for more people to participate, thanks for you interest

@ayan-joshi
Copy link

ayan-joshi commented Oct 2, 2023

I want to work on this issue , Can you please assign this to me @Haimantika @gewenyu99

Hi @ayan-joshi I am unassigning you from this issue, as I have already assigned you two issues. This will leave room for more people to participate, thanks for you interest

I have one request Can u unassign The CM adapter issue , I'll work better on this issue other than the CM adapter .
I will be thankful to you for this help @Haimantika

@Vaibhav91one
Copy link

I want to work on this issue @Haimantika.

@Haimantika
Copy link
Contributor

I want to work on this issue @Haimantika.

Hi, assigned the issue to Ayan now, since we follow first-come first-serve basis, if he doesn’t follow up in 3 days, will assign it to you.

@ayan-joshi
Copy link

I want to work on this issue @Haimantika.

Hi, assigned the issue to Ayan now, since we follow first-come first-serve basis, if he doesn’t follow up in 3 days, will assign it to you.

Thanks

@gewenyu99
Copy link
Contributor Author

@ayan-joshi You'll be following a similar structure and content to this PR: #137

Before starting, please provider an outline of:

  • Every page in your contribution
  • Every heading in your page
  • Why you need these headings and what will be in them.
    Thanks!

@Haimantika
Copy link
Contributor

Hi @ayan-joshi is there an update?

@ayan-joshi
Copy link

Hi @ayan-joshi is there an update?

Ma'am u can unassign this to me I'm working on ionic and it's itself a major issue for me Thanks @Haimantika

@gewenyu99
Copy link
Contributor Author

@Vaibhav91one It's yours now :)

@gewenyu99 gewenyu99 assigned Vaibhav91one and unassigned ayan-joshi Oct 6, 2023
@gewenyu99
Copy link
Contributor Author

@ayan-joshi No problem! Thanks for your help with the Ionic app!

@Vaibhav91one
Copy link

@ayan-joshi No problem! Thanks for your help with the Ionic app!

Will be sharing a outline of the application soon.

@Vaibhav91one
Copy link

@gewenyu99 I have come up with this outline. Please provide feedback and provide the green light.

Page Outline

Common Components

Header:

  • Logo
  • Navigation bar

Footer:

  • Copyright information
  • Links to social media pages
  • Register Page

Login Page:

  • Login Form
  • Button to submit
  • Link for register Page

Register Page:

  • Register Form
  • Button to submit registration
  • Link for login Page

Dashboard

  • Will Provide all the details that were filled
  • Some additional things etc

Will be focusing on the above for now and later will add Verification, Recovery, Delete account functionality.

@gewenyu99
Copy link
Contributor Author

Hi, I decided to do an example project. Please follow the outline and format here:
#89

@mecskyverse
Copy link

Hey, @Vaibhav91one, are you currently working on this issue? It's been a long time since your last follow-up.

@Vaibhav91one
Copy link

Vaibhav91one commented Oct 19, 2023

Sorry, about not providing an update. Will be providing an update tomorrows (20th oct). Have been a little busy with college.

@mecskyverse
Copy link

Hey, @gewenyu99 @Haimantika can I get to work on this issue.

@gewenyu99
Copy link
Contributor Author

@Vaibhav91one Can I get a quick status update? :D

@Vaibhav91one
Copy link

Yup will be making a PR today and If I don't, you can assign it to @mecskyverse

@Vaibhav91one
Copy link

Okay @gewenyu99 I am on step 5. I have covered about creating the app, setting up store, routing, login, logout, register, Some routing restriction. Now, I will be focusing on verification, updating, forgot password.

The app is looking like this if the tutorial is followed. (not the end product)
image
image
image
image
image

A feedback will be much appreciated.

@Vaibhav91one
Copy link

Update, So, I have implemented verification, password recovery and navigation guards to the app. Will be writing it down in the tutorial.

I am having a little trouble with account delete functionality. @gewenyu99. little help will be much appreciated.

@gewenyu99
Copy link
Contributor Author

Update, So, I have implemented verification, password recovery and navigation guards to the app. Will be writing it down in the tutorial.

I am having a little trouble with account delete functionality. @gewenyu99. little help will be much appreciated.

So you can only block your account on the client side.

I would do a block and add a comment that this is to protect user data, once they block their account, there should be server side scripts ran periodically to delete associated data that contains the userID.

@gewenyu99
Copy link
Contributor Author

Okay @gewenyu99 I am on step 5. I have covered about creating the app, setting up store, routing, login, logout, register, Some routing restriction. Now, I will be focusing on verification, updating, forgot password.

The app is looking like this if the tutorial is followed. (not the end product) image image image image image

A feedback will be much appreciated.

Looks great, but please don't include style/css in the tutorials. It's out of scope and distracting. If you must, you can use Pink Design but we prefer if you used none at all :)

@Vaibhav91one
Copy link

@gewenyu99 Okay will add do the addition and changes. First I included some styles, later I though it is out of scope only, So, I removed it.

@Vaibhav91one
Copy link

@gewenyu99 I have made the PR. Please provide feedback (if any) 🤞.
#301

Also, I do have created one PR a few weeks ago. Also, please review it.
appwrite/sdk-for-cli#99

@tessamero tessamero linked a pull request Nov 2, 2023 that will close this issue
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
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants