Starter guide for Android SDK by AniVerma17 · Pull Request #187 · imagekitio/docs-keep-a-changelog

AniVerma17 · 2023-09-26T09:47:31Z

Add the quick start guide to document the steps of installing and using the ImageKit Android SDK.
Update the summary file to add the link of the Android SDK guide.

imagekitio · 2023-10-03T09:55:03Z

+
+## Rendering Images in Android application
+
+Image URL can be created from an image path or using the absolute image URL. You can learn more about it in [docs](https://github.com/imagekit-developer/imagekit-javascript#url-generation).


Why are we linking javascript SDK here?

Removed the hyperlink.

imagekitio · 2023-10-03T09:56:28Z

+// https://ik.imagekit.io/your_imagekit_id/default-image.jpg?tr=h-400,ar-3-2
+```
+
+It will look as shown below. In the sample app, the buttons are present to demonstrate the use of different transformations. \


There is no screenshot right below this. Looks a bit confusing to me. Also there is unwanted \ at the end of this sentence?

imagekitio · 2023-10-03T09:59:00Z

+
+### **Upload policy**
+
+The [UploadPolicy](https://github.com/imagekit-developer/imagekit-android/blob/master/README.md#uploadpolicy) class represents a set of conditions that need to be met for an upload request to be executed.


We can add more details here as to cover why someone might need upload policy in the first place.

imagekitio · 2023-10-03T10:00:13Z

+
+The `ImageKitUploader` can also perform the preprocessing of the image/video to modify them before uploading, by passing an instance of [ImageUploadPreprocessor](https://github.com/imagekit-developer/imagekit-android/blob/master/README.md#image-preprocessing)/[VideoUploadPreprocessor](https://github.com/imagekit-developer/imagekit-android/blob/master/README.md#video-preprocessing).
+
+Currently, follwing processes can be applied by upload preprocessors:


We can add more details to cover the use-case e.g. optimize imagekit storage by avoiding upload of large files, speed up upload request etc.

imagekitio · 2023-10-03T10:02:29Z

+
+## Integrations with third-party libraries
+
+ImageKit Android SDK also provides library extensions for integrations with the following image loading libraries for Android:


This heading should be hyper linked in rendering images section IMO. We can do that in the end.

Added the hyperlink to this section at the end of rendering images section.

…d preprocessors

ahnv · 2024-01-18T06:19:39Z

+## **Clone and run the tutorial app**
+
+For this tutorial, we have used our sample Android app as shown below. If you have your own existing Android app, you can integrate the ImageKit Android SDK to it, the instructions for which are provided in the subsequent sections.
+


We should add a line before the git clone command
Clone tutorial app repository with the following command

ahnv · 2024-01-18T06:20:59Z

+
+#### Initializing the SDK
+
+Initialize our SDK prefereable in the `Application` class or any `Activity` as needed, with the following code:


Suggested change

Initialize our SDK prefereable in the `Application` class or any `Activity` as needed, with the following code:

Initialize our SDK preferably in the `Application` class or any `Activity` as needed, with the following code:

ahnv · 2024-01-18T07:47:01Z

+git clone https://github.com/imagekit-samples/quickstart.git
+```
+
+Open the `android` folder within the cloned repository in Android Studio, and run Gradle sync to install the dependencies that are needed to run the Android app. Then run the app by selecting your target device/emulator and clicking on the Run button in Studio.


This line seems a little confusing and too many things at once

Suggested change

Open the `android` folder within the cloned repository in Android Studio, and run Gradle sync to install the dependencies that are needed to run the Android app. Then run the app by selecting your target device/emulator and clicking on the Run button in Studio.

Once you've cloned the repository, open `android` folder in Android Studio. Perform Gradle sync to install all the necessary dependencies for the Android app. After the sync, run the app by selecting your target device/emulator and clicking on the `Run` button in Studio.

Edited the text for better clarity of each step.

ahnv · 2024-01-18T07:52:40Z

+You should see the following screen. This means the sample app has been set up correctly.
+
+![](<../../.gitbook/assets/Screenshot 2023-09-11 at 2.05.12 PM.png>)
+


Missing section Setup ImageKit Android SDK

This section is necessary to distinguish between the Clone and run the tutorial app and Installing the SDK section. Right now it seems like in the tutorial app you have to install the sdk, but those instructions are for adding sdk into an existing application

Refer: https://docs.imagekit.io/getting-started/quickstart-guides/ios#setup-imagekit-ios-sdk

Added the heading to separate the sections.

ahnv · 2024-01-18T07:55:15Z

+* Aspect Ratio
+* Chained transformation
+
+ImageKit Android SDK provides a function  to each transformation parameter e.g. `height` for `h` and `width` for `w` parameter. It makes your code more readable. See the [full list of supported transformations](https://github.com/imagekit-developer/imagekit-Android#list-of-supported-transformations) in Android SDK on Github.


Suggested change

ImageKit Android SDK provides a function to each transformation parameter e.g. `height` for `h` and `width` for `w` parameter. It makes your code more readable. See the [full list of supported transformations](https://github.com/imagekit-developer/imagekit-Android#list-of-supported-transformations) in Android SDK on Github.

ImageKit Android SDK provides a function to each transformation parameter e.g. `height` for `h` and `width` for `w` parameter. It makes your code more readable. See the [full list of supported transformations](https://github.com/imagekit-developer/imagekit-android#list-of-supported-transformations) in Android SDK on Github.

ahnv · 2024-01-18T07:57:21Z

+
+Let's learn how to upload an image to our media library.
+
+Android SDK provides `ImageKitUploader` which provide functions to allow upload files to the [ImageKit media library](../../media-library/overview/) directly from the client-side.&#x20;


Suggested change

Android SDK provides `ImageKitUploader` which provide functions to allow upload files to the [ImageKit media library](../../media-library/overview/) directly from the client-side. 

Android SDK provides `ImageKitUploader` which provide functions to allow upload files to the [ImageKit media library](../../media-library/overview/) directly from the client-side.

ahnv · 2024-01-18T07:58:11Z

+
+For this, we would need a dummy backend app to authenticate our upload request. API authentication for upload always happens on the backend for security reasons.
+
+The tutorial repository comes with a sample backend server that we can use.&#x20;


Please remove from everywhere, not commenting in the entire page

Suggested change

The tutorial repository comes with a sample backend server that we can use. 

The tutorial repository comes with a sample backend server that we can use.

ahnv · 2024-01-18T07:58:33Z

+
+Android SDK provides `ImageKitUploader` which provide functions to allow upload files to the [ImageKit media library](../../media-library/overview/) directly from the client-side.&#x20;
+
+For using upload functionality, we need to pass `publicKey` while [initializing the SDK](Android.md#setup-imagekit-Android-sdk), and pass the client-generated JSON Web Token (JWT) in the upload method, which the ImageKit.io server uses to authenticate and check that the upload request parameters have not been tampered with after the generation of the token. Refer this [guide](https://docs.imagekit.io/api-reference/upload-file-api/secure-client-side-file-upload#how-to-implement-authenticationendpoint-endpoint) to create the token below on the page.


This is not necessary but URL's are case sensitive, it's better to keep it consistent

Suggested change

For using upload functionality, we need to pass `publicKey` while [initializing the SDK](Android.md#setup-imagekit-Android-sdk), and pass the client-generated JSON Web Token (JWT) in the upload method, which the ImageKit.io server uses to authenticate and check that the upload request parameters have not been tampered with after the generation of the token. Refer this [guide](https://docs.imagekit.io/api-reference/upload-file-api/secure-client-side-file-upload#how-to-implement-authenticationendpoint-endpoint) to create the token below on the page.

For using upload functionality, we need to pass `publicKey` while [initializing the SDK](android.md#setup-imagekit-Android-sdk), and pass the client-generated JSON Web Token (JWT) in the upload method, which the ImageKit.io server uses to authenticate and check that the upload request parameters have not been tampered with after the generation of the token. Refer this [guide](https://docs.imagekit.io/api-reference/upload-file-api/secure-client-side-file-upload#how-to-implement-authenticationendpoint-endpoint) to create the token below on the page.

Animesh Verma added 6 commits September 1, 2023 18:14

ADD: markdown file for Android SDK starter guide

b30c7df

ADD: guide content for Android SDK

2207c69

ADD: link to Android SDK guide in the summary

f887616

ADD: sample app screenshots for examples

e3be061

UPDATE: instruction for opening the sample app

c25c3ed

FIX: code typos and guide content

6e1ea1c

imagekitio suggested changes Dec 15, 2023

View reviewed changes

Animesh Verma added 2 commits December 21, 2023 00:21

ADD: missing screenshot and usability description of upload policy an…

ba33280

…d preprocessors

ADD: hyperlink to extensions section in image rendering section

4b25727

ahnv suggested changes Jan 18, 2024

View reviewed changes

ADD: text and headings for sections' segregation

33b807b

AniVerma17 force-pushed the chore/android_quickstart_guide branch from b043074 to 33b807b Compare January 22, 2024 13:18


		## Rendering Images in Android application

		Image URL can be created from an image path or using the absolute image URL. You can learn more about it in [docs](https://github.com/imagekit-developer/imagekit-javascript#url-generation).


		### Upload policy

		The [UploadPolicy](https://github.com/imagekit-developer/imagekit-android/blob/master/README.md#uploadpolicy) class represents a set of conditions that need to be met for an upload request to be executed.


		The `ImageKitUploader` can also perform the preprocessing of the image/video to modify them before uploading, by passing an instance of [ImageUploadPreprocessor](https://github.com/imagekit-developer/imagekit-android/blob/master/README.md#image-preprocessing)/[VideoUploadPreprocessor](https://github.com/imagekit-developer/imagekit-android/blob/master/README.md#video-preprocessing).

		Currently, follwing processes can be applied by upload preprocessors:


		## Integrations with third-party libraries

		ImageKit Android SDK also provides library extensions for integrations with the following image loading libraries for Android:

		## Clone and run the tutorial app

		For this tutorial, we have used our sample Android app as shown below. If you have your own existing Android app, you can integrate the ImageKit Android SDK to it, the instructions for which are provided in the subsequent sections.


		#### Initializing the SDK

		Initialize our SDK prefereable in the `Application` class or any `Activity` as needed, with the following code:

	Initialize our SDK prefereable in the `Application` class or any `Activity` as needed, with the following code:
	Initialize our SDK preferably in the `Application` class or any `Activity` as needed, with the following code:

	Open the `android` folder within the cloned repository in Android Studio, and run Gradle sync to install the dependencies that are needed to run the Android app. Then run the app by selecting your target device/emulator and clicking on the Run button in Studio.
	Once you've cloned the repository, open `android` folder in Android Studio. Perform Gradle sync to install all the necessary dependencies for the Android app. After the sync, run the app by selecting your target device/emulator and clicking on the `Run` button in Studio.

		You should see the following screen. This means the sample app has been set up correctly.

		![](<../../.gitbook/assets/Screenshot 2023-09-11 at 2.05.12 PM.png>)

	ImageKit Android SDK provides a function to each transformation parameter e.g. `height` for `h` and `width` for `w` parameter. It makes your code more readable. See the [full list of supported transformations](https://github.com/imagekit-developer/imagekit-Android#list-of-supported-transformations) in Android SDK on Github.
	ImageKit Android SDK provides a function to each transformation parameter e.g. `height` for `h` and `width` for `w` parameter. It makes your code more readable. See the [full list of supported transformations](https://github.com/imagekit-developer/imagekit-android#list-of-supported-transformations) in Android SDK on Github.


		Let's learn how to upload an image to our media library.

		Android SDK provides `ImageKitUploader` which provide functions to allow upload files to the [ImageKit media library](../../media-library/overview/) directly from the client-side.


		For this, we would need a dummy backend app to authenticate our upload request. API authentication for upload always happens on the backend for security reasons.

		The tutorial repository comes with a sample backend server that we can use.


		Android SDK provides `ImageKitUploader` which provide functions to allow upload files to the [ImageKit media library](../../media-library/overview/) directly from the client-side.

		For using upload functionality, we need to pass `publicKey` while [initializing the SDK](Android.md#setup-imagekit-Android-sdk), and pass the client-generated JSON Web Token (JWT) in the upload method, which the ImageKit.io server uses to authenticate and check that the upload request parameters have not been tampered with after the generation of the token. Refer this [guide](https://docs.imagekit.io/api-reference/upload-file-api/secure-client-side-file-upload#how-to-implement-authenticationendpoint-endpoint) to create the token below on the page.

Conversation

AniVerma17 commented Sep 26, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AniVerma17 Jan 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

AniVerma17 Jan 22, 2024 •

edited

Loading