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 tutorial with SvelteKit #89

Open
2 tasks done
gewenyu99 opened this issue Sep 27, 2023 · 5 comments
Open
2 tasks done
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@gewenyu99
Copy link
Contributor

gewenyu99 commented Sep 27, 2023

💭 Description

Goal

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

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
    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
@mbos2
Copy link

mbos2 commented Oct 1, 2023

Hey

Can I work on this?

I have experience with this, and SvelteKit. I can add Typescript to this (prefered).

Tutorial outline:

  • Introduction
  • Setup
    • Creating SvelteKit project
    • Installing necessary dependencies
    • Files and Folders structure for our application
  • Routes
    • Short explanation and pointers about what our UI routes are, what might API routes be
  • Sign up
    • How it works
    • Explaining the sign up flow
    • Password protection with Argon 2
      • Possibly explaining why is Password encryption important and how password encryption works
    • Code and/or Graph representation of the flow (Architecture graph would look nice as an explanation point)
  • SIgn in
    • How it works
    • Explaining the sign up flow
    • Code and/or Graph representation of the flow (Architecture graph would look nice as an explanation point)
  • Account Verification
    • How it works
    • Other (possible) Methods you can use for account verification (optional)
  • Account Recovery
    • How it works
    • Other (possible) Methods you can use for account verification (optional)
  • Preferences
  • Delete Account
    • Delete account flow
    • Importance of security checks before executing the action
    • Implementation and explanation of Importance of Soft Deletes
      • Cloud function executed by CRON task that checks Soft deleted accounts to permanently delete them after X period of time

This is rought tutorial outline that could slightly change based on the developed app if changes to it are more logical than the structure I presented.

Most of these Sections will be followed by small code examples.

@gewenyu99 gewenyu99 self-assigned this Oct 2, 2023
@gewenyu99
Copy link
Contributor Author

@mbos2 I'd love to have your contribution, I actually cranked this one out yesterday myself, feel free to take up any other client framework, also would love your review here:
#137

@mbos2
Copy link

mbos2 commented Oct 2, 2023

Oh ...

Well, others are already assigned, I was waiting for this one.
Guess it's done already then :)

@gewenyu99
Copy link
Contributor Author

Oh ...

Well, others are already assigned, I was waiting for this one. Guess it's done already then :)

Would you like to propose something else? DM me on Discord, we can work something out ;)

@gewenyu99
Copy link
Contributor Author

gewenyu99 commented Oct 10, 2023

For those referred here, here's the related PR:
#137

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
Projects
None yet
Development

No branches or pull requests

3 participants