Documentation: Tutorial for Apple #217

Mujhtech · 2023-10-07T11:03:17Z

What does this PR do?

Added tutorial for Apple in Docs

Test Plan

The Tutorial can be found in the route /docs/tutorials/apple/step-1

Related PRs and Issues

#94

Have you read the [Contributing Guidelines on issues]

Yes

close #94

vercel · 2023-10-07T11:03:21Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
website	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 31, 2023 6:28am

gewenyu99

Hey, thank you so much for your PR. I really like that you create a habit tracker app, which is unique and super interesting.

I have some comments, and some of them apply to all pages, please carefully review them and apply to them all.

Let's fix these formatting issues, then I'll take a look at the code.

src/routes/docs/tutorials/+page.svelte

gewenyu99 · 2023-10-12T20:46:33Z

src/routes/docs/tutorials/apple/step-1/+page.markdoc

-The Appwrite docs, just like Appwrite, is completely open sourced.
-This means, anyone can help improve them and add new guides and tutorials. 
+{% only_dark %}
+![Habit Tracker Screenshot](/images/docs/tutorials/dark/apple-habit-tracker.png)


Please give me originals of all your screenshots taking in a 1400x900 view port using DPR:3.0 on your browser's developer tools.

We will have our design team edit the screenshots to fit our style.

@Mujhtech please provide original images for all screenshots.

Those are the screenshots @gewenyu99

src/routes/docs/tutorials/apple/step-1/+page.markdoc

src/routes/docs/tutorials/apple/step-10/+page.markdoc

src/routes/docs/tutorials/apple/step-4/+page.markdoc

gewenyu99 · 2023-10-12T20:59:52Z

src/routes/docs/tutorials/apple/step-7/+page.markdoc

+}
+```
+
+Add the following code to HomeScreen.swift inside **Home/View** folder. Here we will be using newly introduce ``ContentUnavailableView`` if the habits is empty else render ``HabitCellView`` inside the loop.


The code tags aren't correct here.

This was not resolved

Code tags here aren't working, should be single ` instead of two

gewenyu99 · 2023-10-13T21:26:08Z

@Mujhtech Remember to rerequest review from me so I know it's ready to look at again!

Mujhtech · 2023-10-16T04:53:28Z

@gewenyu99 You can check this out, I have pushed some update

Mujhtech · 2023-10-17T15:28:39Z

@gewenyu99 You can check this out, I have pushed some update

@gewenyu99

gewenyu99

Hi, did you forget to push your changes, my comments were not resolved.

src/routes/docs/tutorials/+page.svelte

gewenyu99 · 2023-10-18T03:20:03Z

src/routes/docs/tutorials/apple/step-1/+page.markdoc

-The Appwrite docs, just like Appwrite, is completely open sourced.
-This means, anyone can help improve them and add new guides and tutorials. 
+{% only_dark %}
+![Habit Tracker Screenshot](/images/docs/tutorials/dark/apple-habit-tracker.png)


@Mujhtech please provide original images for all screenshots.

src/routes/docs/tutorials/apple/step-2/+page.markdoc

src/routes/docs/tutorials/apple/step-3/+page.markdoc

gewenyu99 · 2023-10-18T03:23:41Z

src/routes/docs/tutorials/apple/step-7/+page.markdoc

+}
+```
+
+Add the following code to HomeScreen.swift inside **Home/View** folder. Here we will be using newly introduce ``ContentUnavailableView`` if the habits is empty else render ``HabitCellView`` inside the loop.


This was not resolved

src/routes/docs/tutorials/apple/step-4/+page.markdoc

Mujhtech · 2023-10-18T07:02:27Z

src/routes/docs/tutorials/apple/step-7/+page.markdoc

+                ContentUnavailableView(label: {
+                    Label("No habits", systemImage: "calendar")
+                }, description: {
+                    Text("Start adding habit to see your list")
+                }, actions: {
+                    Button("Add Habit") {
+                        router.push(.add_habit)
+                    }
+                })


This is what I was trying to reference to

Mujhtech · 2023-10-24T07:03:10Z

@gewenyu99

Mujhtech · 2023-10-25T08:17:25Z

src/routes/docs/tutorials/apple/step-3/+page.markdoc

+Create a database file in the **Shared/Constant** folder to contain the database id and collection id.
+
+```swift
+import Foundation
+
+enum Database: String {
+    case habit = "[DATABASE_ID]"
+}
+
+
+enum DatabaseCollections : String {
+    case habits = "[COLLECTION_ID]"
+}
+```


Here @gewenyu99

gewenyu99

Hey, great work, but I think we have a lot of missing information and changes needed still. Can you upload the full app code into a repo, too? So I can go check and see when there's something missing/weird when I'm following, so there's less back and forth.

src/routes/docs/tutorials/apple/step-3/+page.markdoc

src/routes/docs/tutorials/apple/step-4/+page.markdoc

gewenyu99 · 2023-10-25T19:16:07Z

src/routes/docs/tutorials/apple/step-5/+page.markdoc

+
+# Router {% #router %}
+
+Add the following code to Router.swift File in the root folder


I feel like we need just a little more explanation, not a lot, in each of these steps to describe what the files do and point out any documentation to swift docs that are relevant.

src/routes/docs/tutorials/apple/step-8/+page.markdoc

gewenyu99 · 2023-10-25T19:48:12Z

src/routes/docs/tutorials/apple/step-6/+page.markdoc

+    }
+}
+
+#Preview {


This a typo?

src/routes/docs/tutorials/apple/step-5/+page.markdoc

src/routes/docs/tutorials/apple/step-4/+page.markdoc

Mujhtech · 2023-10-26T06:48:49Z

Hey, great work, but I think we have a lot of missing information and changes needed still. Can you upload the full app code into a repo, too? So I can go check and see when there's something missing/weird when I'm following, so there's less back and forth.

Here is the link to the repository https://github.com/Mujhtech/appwrite-hacktoberfest

gewenyu99 · 2023-10-29T19:40:21Z

@Mujhtech Have you had a chance to take a look at my comments?

Mujhtech · 2023-10-29T20:00:08Z

Have you checked the link? I was kind of expecting your feedback and note I'm still working on your comment and will resolve all by tomorrow @gewenyu99

gewenyu99 · 2023-10-30T21:53:08Z

@Mujhtech If you were wondering, I couldn't build your project at all

gewenyu99 · 2023-10-30T21:56:47Z

Are you on Xcode 15? Xcode 15 is currently in beta and iOS 17 is not wide spread. Can you revert to a previous directive in your app?

gewenyu99 · 2023-10-31T22:30:38Z

Hey,

Due to time constraints, I'm going to mark this PR hacktoberfest-accepted for now so you get DO's Hacktoberfest rewards. We'll continue to work with you on this issue for review and merge.

When it is merged, we'll contact you for Appwrite-specific Hacktoberfest swag.

Thanks for helping us improve Appwrite!

gewenyu99 · 2023-10-31T22:36:25Z

Hey,

Due to time constraints, I'm going to mark this PR hacktoberfest-accepted for now so you get DO's Hacktoberfest rewards. We'll continue to work with you on this issue for review and merge.

When it is merged, we'll contact you for Appwrite-specific Hacktoberfest swag.

Thanks for helping us improve Appwrite!

Mujhtech · 2023-11-01T07:34:07Z

Are you on Xcode 15? Xcode 15 is currently in beta and iOS 17 is not wide spread. Can you revert to a previous directive in your app?

Yes, I'm using Xcode 15, and it is stable. You can comment on those preview directives and it should work, or can I do it and push the changes? Also I have push some update here @gewenyu99

Kilo-Loco

There is a lot of great work here:

You are going through steps that will be very valuable for users
Your opinionated approach will likely teach users some best practices for SwiftUI
You're paving the way for iOS devs to understand how Appwrite can be used in their projects

I think it's worth noting that this tutorial will not help Appwrite achieve parity with the other platforms. While it's innovative to show how to build an app other than an idea tracker with Appwrite, any multilingual devs, or teams looking to familiarize themselves with Appwrite, will not have consistent resources across those platforms. Additionally, this tutorial goes above and beyond an Auth recipe, which means it doesn't sufficiently fix #94 .

All things considered, I'd like to know what @Mujhtech and @gewenyu99 think should be the next steps for this PR.

src/routes/docs/tutorials/apple/step-1/+page.markdoc

src/routes/docs/tutorials/apple/step-2/+page.markdoc

src/routes/docs/tutorials/apple/step-3/+page.markdoc

src/routes/docs/tutorials/apple/step-4/+page.markdoc

src/routes/docs/tutorials/apple/step-6/+page.markdoc

Kilo-Loco · 2024-01-27T04:36:35Z

static/images/docs/tutorials/dark/xcode-new-project-setup.png

Is this screenshot being used in the tutorial? Also, why is it different from static/images/docs/tutorials/xcode-new-project-setup.png ?

Yeah it is, @gewenyu99 mentioned I used at least provide screenshot for both dark and light mode so one is dark while other one light.

src/routes/docs/tutorials/apple/step-9/+page.markdoc

Kilo-Loco · 2024-01-27T04:42:59Z

src/routes/docs/tutorials/apple/step-7/+page.markdoc

Several views are being implemented in this step; we should consider including screenshots of the different views. This will help users following along by ensuring their UI looks as expected and help users simply reading through to visually understand what is happening in the app.

I think the idea is to limit the number of files added to the repo as much as possible so that's while in the header screenshot I made sure that all those screenshot are included

Kilo-Loco · 2024-01-27T04:44:32Z

src/routes/docs/tutorials/apple/step-8/+page.markdoc

Why is this UI different/special that it deserves its own step outside of the Habit UI step?

That's the UI for creating/add new habit.

Mujhtech · 2024-01-30T01:44:03Z

@Kilo-Loco I have pushed some changes, you can go through it again.

Kilo-Loco

LGTM. Good job @Mujhtech

Kilo-Loco

This looks really good and we are definitely nearing the end. I think that we should consider removing the reference and step that shows OAuth as the tutorial isn't illustrating that specific flow.

Kilo-Loco · 2024-01-30T02:09:30Z

src/routes/docs/tutorials/apple/step-4/+page.markdoc

@@ -7,7 +7,7 @@ step: 4

 # Appwrite service {% #appwrite-service %}

-Create a new file AppwriteService.swift inside `Shared/Services` folder and add the following code to it, replacing [YOUR_PROJECT_ID] with your project ID.
+Create a new file AppwriteService.swift inside `Shared/Services` folder and add the following code to it, replacing [YOUR_PROJECT_ID] with your project ID. The purpose of this file is to initialize Appwrite SDK and create necessary methods needed for both authentication and read/write from documents.


I like that clarification was added here 👍🏽

Kilo-Loco · 2024-01-30T02:11:27Z

src/routes/docs/tutorials/apple/step-6/+page.markdoc

@@ -7,6 +7,66 @@ step: 6

 # Authentication {% #authentication %}

+In order to allow creating OAuth sessions, the following URL scheme must be added to your **Info.plist** file.


I don't think we are actually using OAuth in this flow. This means we should be able to omit the changes to the Info.plist altogether.

Kilo-Loco · 2024-01-30T02:15:52Z

src/routes/docs/tutorials/apple/step-6/+page.markdoc

+In `AppwriteService.swift`, let's update the object to include the auth methods by adding the following snippets.
+
+```swift
+    public func currentSession() async throws -> User<[String: AnyCodable]> {


I think we should either change the name or the functionality of the function to match what is actually happening. The function is getting the current user as is, but if we want to show it getting the current session, we should use the snippet below:

Suggested change

public func currentSession() async throws -> User<[String: AnyCodable]> {

func currentSession() async throws -> Session {

try await account.getSession(

sessionId: "current"

)

}

Kilo-Loco · 2024-01-30T02:17:21Z

src/routes/docs/tutorials/apple/step-9/+page.markdoc

@@ -8,3 +8,15 @@ step: 10
 # Test your project {% #test-project %}
 At the top level menu click on **Product** then **Scheme** and click on **Choose scheme**, you will notice that the active scheme is selected if not click on it to mark it selected then next to it select any iOS Simulator you wish to run the app on then click on play button.

+# Delete Appwrite Project in Console {% #delete-appwrite-project-in-console %}


I love that we are showing the user how to remove their project from the console. This is a huge plus in terms of keeping their account secure 😍

Kilo-Loco · 2024-01-30T02:27:08Z

I still want us to consider whether this PR actually addresses #94 like the SvelteKit tutorial or if it is providing the user with a Mobile and Native tutorial like Android Tutorial.

gewenyu99 · 2024-04-08T20:19:51Z

@Mujhtech Hey there! There were a lot of big PRs during this Hacktoberfest, and we wanted to give everyone ample time to collaborate with our engineering team. If you were able to merge your PRs during October, amazing. If it’s still not merged, don’t worry about it either. Either way, we’ve got your Hacktoberfest swag minted and ready to ship.

Please comment with your Discord username here so we can contact you about your shipping information to deliver your Hacktoberfest swag.

Mujhtech · 2024-04-08T20:21:54Z

@gewenyu99 my discord username is mujhtech

Mujhtech · 2024-04-10T16:31:32Z

@gewenyu99 Please kindly confirm when you see it and also I dropped message to your DM on Discord

gewenyu99 · 2024-04-19T16:19:24Z

Be in touch soon! Putting together some last minute things we need :)

Mujhtech added 3 commits October 6, 2023 17:00

feat: add apple + appwrite implementation tutorial

b7e83ec

Merge branch 'main' into feat-add-apple-tutorial

ceac345

chore: update step-3 with database setup

b8dfd8d

vercel bot deployed to Preview October 7, 2023 11:07 View deployment

gewenyu99 suggested changes Oct 12, 2023

View reviewed changes

Mujhtech added 2 commits October 12, 2023 23:28

chore: update doc steps

edc79d8

Merge branch 'main' into feat-add-apple-tutorial

97c1536

vercel bot deployed to Preview October 12, 2023 22:33 View deployment

gewenyu99 self-requested a review October 13, 2023 21:25

chore: update code formatting

41db635

vercel bot deployed to Preview October 14, 2023 02:27 View deployment

update docs

148330f

vercel bot deployed to Preview October 16, 2023 04:39 View deployment

chore: update code snippet

06b5263

vercel bot deployed to Preview October 16, 2023 04:56 View deployment

gewenyu99 suggested changes Oct 18, 2023

View reviewed changes

src/routes/docs/tutorials/apple/step-4/+page.markdoc Outdated Show resolved Hide resolved

Mujhtech added 2 commits October 18, 2023 07:32

Merge branch 'main' into feat-add-apple-tutorial

d19cf57

chore: update the placeholder and added screenshot for light mode

6d8396b

vercel bot deployed to Preview October 18, 2023 06:46 View deployment

chore: update the create database step

5502966

Mujhtech commented Oct 18, 2023

View reviewed changes

vercel bot deployed to Preview October 18, 2023 07:02 View deployment

TorstenDittmann added the documentation Improvements or additions to documentation label Oct 18, 2023

Haimantika requested a review from gewenyu99 October 19, 2023 11:42

fixed code block

823c3e3

Mujhtech commented Oct 25, 2023

View reviewed changes

vercel bot deployed to Preview October 25, 2023 08:22 View deployment

gewenyu99 suggested changes Oct 25, 2023

View reviewed changes

chore: update some changes

de91e6a

vercel bot deployed to Preview October 31, 2023 06:28 View deployment

gewenyu99 added the hacktoberfest-accepted label Oct 31, 2023

github-actions bot mentioned this pull request Nov 1, 2023

PRs Opened in October 2023 appwrite/.github#93

Closed

Mujhtech requested a review from gewenyu99 November 13, 2023 16:16

Kilo-Loco suggested changes Jan 27, 2024

View reviewed changes

Mujhtech added 3 commits January 30, 2024 01:53

Merge branch 'main' into feat-add-apple-tutorial

1155d2b

fixed typo

bc585cb

fixed some issues and add delete project in step 9

fb724e4

Mujhtech requested a review from Kilo-Loco January 30, 2024 01:44

Kilo-Loco approved these changes Jan 30, 2024

View reviewed changes

Kilo-Loco reviewed Jan 30, 2024

View reviewed changes


		# Router {% #router %}

		Add the following code to Router.swift File in the root folder

		@@ -7,6 +7,66 @@ step: 6

		# Authentication {% #authentication %}

		In order to allow creating OAuth sessions, the following URL scheme must be added to your Info.plist file.

-    public func currentSession() async throws -> User<[String: AnyCodable]> {
+func currentSession() async throws -> Session {
+    try await account.getSession(
+        sessionId: "current"
+    )
+}

Documentation: Tutorial for Apple #217

Are you sure you want to change the base?

Documentation: Tutorial for Apple #217

Conversation

Mujhtech commented Oct 7, 2023 • edited Loading

What does this PR do?

Test Plan

Related PRs and Issues

Have you read the [Contributing Guidelines on issues]

vercel bot commented Oct 7, 2023 • edited Loading

gewenyu99 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gewenyu99 commented Oct 13, 2023

Mujhtech commented Oct 16, 2023

Mujhtech commented Oct 17, 2023

gewenyu99 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Mujhtech commented Oct 24, 2023

Choose a reason for hiding this comment

gewenyu99 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Mujhtech commented Oct 26, 2023

gewenyu99 commented Oct 29, 2023

Mujhtech commented Oct 29, 2023

gewenyu99 commented Oct 30, 2023

gewenyu99 commented Oct 30, 2023

gewenyu99 commented Oct 31, 2023

gewenyu99 commented Oct 31, 2023 • edited Loading

Mujhtech commented Nov 1, 2023

Kilo-Loco left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Mujhtech commented Jan 30, 2024

Kilo-Loco left a comment

Choose a reason for hiding this comment

Kilo-Loco left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Kilo-Loco commented Jan 30, 2024

gewenyu99 commented Apr 8, 2024

Mujhtech commented Apr 8, 2024

Mujhtech commented Apr 10, 2024

gewenyu99 commented Apr 19, 2024

Mujhtech commented Oct 7, 2023 •

edited

Loading

vercel bot commented Oct 7, 2023 •

edited

Loading

gewenyu99 commented Oct 31, 2023 •

edited

Loading