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: Android tutorial using Java #82

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

📚 Documentation: Android tutorial using Java #82

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

Comments

@gewenyu99
Copy link
Contributor

💭 Description

While the Appwrite team will write an App using Android Kotlin, we do not have a tutorial on Java. For community members that are fluent in Android development using Java, we'd love to see contributions here.

Goal

Interactive tutorial for beginners to build their first functioning app using Android (Java) 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
@SanjayDevTech
Copy link

SanjayDevTech commented Oct 1, 2023

I would like to work on this issue😄 @gewenyu99

@Haimantika
Copy link
Contributor

I would like to work on this issue😄 @gewenyu99

Hi @SanjayDevTech 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!

@gewenyu99
Copy link
Contributor Author

@SanjayDevTech It's yours. Happy hacktoberfest!

@niranjanjgowda
Copy link

Hey @Haimantika Please do assign it to me if @SanjayDevTech drops :>

@Haimantika
Copy link
Contributor

Hi @SanjayDevTech reassigning this issue to @i-nj due to inactivity from your end

@niranjanjgowda
Copy link

Hey, Thank you. I will start working on the outline

@letsintegreat
Copy link

Hey, I would like to be assigned if the current assignee is unresponsive, thanks!

@niranjanjgowda niranjanjgowda removed their assignment Oct 9, 2023
@RedWing0021
Copy link

Hi, I would like to work on this issue, if no one is working on this. Please assign this to me.

@gewenyu99
Copy link
Contributor Author

@letsintegreat you're next in line, it's yours since @i-nj unassigned themselves.

Happy hacktoberfest, you don't have to finish in 3 days but give us an update!

@letsintegreat
Copy link

@gewenyu99 Thanks, please assign the issue to me. I will share the outline soon.

@tessamero
Copy link
Contributor

Hi @letsintegreat , I have assigned the issue to you, good luck and happy hacking. Please update us every 3 days if you are still working on it so it doesn't get reassigned :)

@letsintegreat
Copy link

Hey @gewenyu99 and @tessamero Here is my proposed outline for the tutorial. LMK if I can continue with this.

  1. Develop a Recipe Sharing App with Java and Appwrite.

    • Introduce the tutorial.
    • Share some resources/links to download Android Studio and other tools (prerequisites).
  2. Create the app

    • Initialize a new project on Android Studio.
    • Provide a starting code with UI filled with dummy data and empty on-click listeners.
  3. Setup Appwrite

    • Add Appwrite dependencies in the project.
    • Set up a new project on Appwrite console.
  4. Add authentication

    • Set up authentication in Appwrite console.
    • Implement on-click listeners of login/signup page.
  5. Add database

    • Set up database in Appwrite console.
    • Implement database operations into the app.
    • Provide links to learn about database permissions.
  6. Add Query

    • Implement a search feature on the recipe list page to showcase how database query works.
  7. Add pagination

    • Introduce pagination on the recipe list page.
  8. Conclusion

    • Provide links to learn about remaining Appwrite features.
    • Conclude the tutorial.

@gewenyu99
Copy link
Contributor Author

@letsintegreat This looks like a great start. Let's go with this and see what happens. We might want to add storage + images in to the mix too, but that would be optional.

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.

7 participants