appwrite / website

The Appwrite website, docs and blog 🏠
https://appwrite.io
207 stars 199 forks source link

📚 Documentation: Tutorial for Ionic #85

Open gewenyu99 opened 1 year ago

gewenyu99 commented 1 year ago

💭 Description

Goal

Interactive tutorial for beginners to build their first functioning app using Ionic 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?

🏢 Have you read the Code of Conduct?

ayan-joshi commented 1 year ago

Hello , I would like to contribute and work on this issue please assign it to me @gewenyu99 @Haimantika

Haimantika commented 1 year ago

Hello , I would like to contribute and work on this issue please assign it to me @gewenyu99 @Haimantika

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!

ayan-joshi commented 1 year ago

Hello , I would like to contribute and work on this issue please assign it to me @gewenyu99 @Haimantika

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!

Okay sure

ayan-joshi commented 1 year ago

Hello , I would like to contribute and work on this issue please assign it to me @gewenyu99 @Haimantika

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!

I have a doubt we have to make a Readme file for the following issue explaining the features they asked or just a doc format file ? @Haimantika @gewenyu99

gewenyu99 commented 1 year ago

@ayan-joshi Hi, you've been assigned to two issues. Would you like to follow this issue or the Vue auth deep dive?

We're only assigning one issue per person. Thanks!

ayan-joshi commented 1 year ago

@ayan-joshi Hi, you've been assigned to two issues. Would you like to follow this issue or the Vue auth deep dive?

We're only assigning one issue per person. Thanks!

I'll work on tutorial for ionic @gewenyu99

ayan-joshi commented 1 year ago

So here's my outline for the Tutorial for ionic

Page 1: Introduction Heading: Welcome to the Ionic and Appwrite Tutorial Content: Briefly introduce the tutorial, its goals, and what the reader will learn by the end.

Page 2: Prerequisites Heading: Prerequisites Content: List the requirements for this tutorial, such as having Node.js and npm installed, an Appwrite server set up, and a basic understanding of Ionic.

Page 3: Getting Started with Ionic Heading: Getting Started with Ionic Content: Provide step-by-step instructions on setting up an Ionic project, including installation, creating a new app, and configuring the development environment.

Page 4: Implementing Authentication Heading: Implementing Authentication Content: Guide the reader on setting up user authentication within their Ionic app, utilizing Appwrite's authentication features.

Page 5: Introduction to Databases Heading: Introduction to Databases Content: Explain the basics of using Appwrite's database service within the Ionic app, including creating collections, documents, and CRUD operations.

Page 6: Queries and Paginations Heading: Queries and Paginations Content: Teach the reader how to perform queries and implement pagination for their data using Appwrite's database service . Page 7: Storage (Optional) Heading: Working with Storage (Optional) Content: If chosen, provide instructions on using Appwrite's storage service to manage and store files within the Ionic app.

Page 8: Conclusion Heading: Conclusion Content: Summarize what the reader has learned, encourage them to explore further, or build upon the knowledge gained in the tutorial.

This revised outline condenses the content while still covering the key topics required to build a functional Ionic app with Appwrite. So have a look at it so I will start my work for pull request @gewenyu99 @Haimantika

ayan-joshi commented 1 year ago

@gewenyu99 Can you add hacktoberfest label in the project , it's showing not participated for my pr

gewenyu99 commented 1 year ago

@ayan-joshi The outline looks good. Make sure to take a look at the other tutorials to have a consistent format.

This issue is already marked with Hacktoberfest!

ayan-joshi commented 1 year ago

@ayan-joshi The outline looks good. Make sure to take a look at the other tutorials to have a consistent format.

This issue is already marked with Hacktoberfest!

yes I'll look at other tutorials , but sir the label problem is of repository not issue the appwrite website repository don't have hacktoberfest label so it will be not counted for hacktoberfest can you solve this issue @gewenyu99

gewenyu99 commented 1 year ago

@ayan-joshi We will be labeling individual PRs with hacktoberfest-accepted, since we are not taking contributions to the entire repo, and only select issues.

Thanks!

ayan-joshi commented 1 year ago

@ayan-joshi We will be labeling individual PRs with hacktoberfest-accepted, since we are not taking contributions to the entire repo, and only select issues.

Thanks!

That's great sir but the problem is it's showing not participated on hacktoberfest because the repository is not labeled hacktoberfest , not all will be counted as hacktoberfest issues unless it's labelled on the issue . So the repository should have label of hacktoberfest necessarily otherwise our contribution would not be counted please help it sir others also have same doubts @gewenyu99

Haimantika commented 1 year ago

@ayan-joshi We will be labeling individual PRs with hacktoberfest-accepted, since we are not taking contributions to the entire repo, and only select issues. Thanks!

That's great sir but the problem is it's showing not participated on hacktoberfest because the repository is not labeled hacktoberfest , not all will be counted as hacktoberfest issues unless it's labelled on the issue . So the repository should have label of hacktoberfest necessarily otherwise our contribution would not be counted please help it sir others also have same doubts @gewenyu99

Hi, it will be counted valid, when your PR gets reviewed and gets the hacktoberfest-accepted label

ayan-joshi commented 1 year ago

@ayan-joshi We will be labeling individual PRs with hacktoberfest-accepted, since we are not taking contributions to the entire repo, and only select issues. Thanks!

That's great sir but the problem is it's showing not participated on hacktoberfest because the repository is not labeled hacktoberfest , not all will be counted as hacktoberfest issues unless it's labelled on the issue . So the repository should have label of hacktoberfest necessarily otherwise our contribution would not be counted please help it sir others also have same doubts @gewenyu99

Hi, it will be counted valid, when your PR gets reviewed and gets the hacktoberfest-accepted label

okayy as you say , sorry for so much of questions @Haimantika @gewenyu99

Haimantika commented 1 year ago

@ayan-joshi any update?

ayan-joshi commented 1 year ago

@ayan-joshi any update?

Yes working on it

Shunux-Stuxnet commented 1 year ago

Hi @gewenyu99 @Haimantika Can you assign this issue to me ?

Haimantika commented 1 year ago

Hi @gewenyu99 @Haimantika Can you assign this issue to me ?

Hi, Ayan has already worked on it. Please find unassigned issues :)