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: Tutorial for Nuxt #84

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

📚 Documentation: Tutorial for Nuxt #84

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

Comments

@gewenyu99
Copy link
Contributor

💭 Description

Goal

Interactive tutorial for beginners to build their first functioning app using Nuxt and Appwrite.

Content

  1. The end product should be a functional app
  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. install dependencies
    2. make first request
    3. implement auth
    4. intro to databases
    5. queries and paginations
    6. storage (optional)
    7. realtime (optional)
    8. permissions (optional)

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
@evelinabe
Copy link
Contributor

evelinabe commented Oct 1, 2023

Hi, I would like to be assigned this issue. I'm thinking it will follow the exact same steps as the beginner tutorials for React, Sveltekit and Vue with the end result being an ideas tracker app. The outline would be something like this:

1. Build an ideas tracker with Nuxt

  • Concepts

  • Prerequisites

2. Create app

  • Create Nuxt project

  • Add dependencies

3. Set up Appwrite

  • Create project

  • Initialize Appwrite SDK

4. Add authentication

  • Composer
  • Login/register Page

5. Add navigation

  • Simple navbar

6. Add database

  • Create collection
  • Basic methods

7. Create ideas page

8. Next steps

  • Test your project
  • Add style

@gewenyu99
Copy link
Contributor Author

@evelinabe Can I challenge you in an additional step of uploading and displaying images? ;)

I've assigned it to you, happy hacking, make sure every 2-3 days to give us a quick status update!

@evelinabe
Copy link
Contributor

@evelinabe Can I challenge you in an additional step of uploading and displaying images? ;)

I've assigned it to you, happy hacking, make sure every 2-3 days to give us a quick status update!

Challenge accepted

@Amit12234
Copy link

Hi , if it get unassigned , please assign it to me.

@evelinabe
Copy link
Contributor

@Amit12234 I'm assigned to it and currently working on it :-)

@evelinabe
Copy link
Contributor

@gewenyu99 status-report: making progress. Added checkboxes to the outline and checked the ones that are finished.

@evelinabe
Copy link
Contributor

@gewenyu99 Some styling left before I open a PR

@gewenyu99
Copy link
Contributor Author

@evelinabe thanks for the update!

Please also have your complete code ready in a repository like https://github.com/loks0n?tab=repositories

So we can fork + add to Appwrite and link in tutorial in the future!

@evelinabe
Copy link
Contributor

@gewenyu99 Here's the repo: https://github.com/evelinabe/nuxt-ideas-tracker-tutorial
Aha, I thought I was supposed to add the tutorial in the appwrite-website repo as well? Then I'm nearly done, I suppose :D

This was referenced Oct 13, 2023
@evelinabe
Copy link
Contributor

@gewenyu99 Closed the first PR because I had forgotten to pull the latest changes from main and I thought the history got so messy when I wanted to do some changes after seeing in another review that you wanted minimal styling or pink.appwrite.io. Changes done and new PR opened. Have a nice weekend!

@tessamero tessamero linked a pull request Nov 2, 2023 that will close this issue
gewenyu99 pushed a commit that referenced this issue Nov 17, 2023
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.

4 participants