Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions src/directory/directory.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,16 @@ const directory = {
route: '/lib'
},
items: {
devpreview: {
title: 'New! Amplify Mobile (Developer Preview)',
items: [
{
title: 'Getting started',
route: '/lib/devpreview/getting-started',
filters: ['android']
}
]
},
'project-setup': {
title: 'Project Setup',
items: [
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
The Developer Preview of the Amplify Android Library is now exclusively using Kotlin and provides developers the ability to add cloud-based Auth, Storage, DataStore, and APIs to their apps. With this version, developers will be able to debug and contribute to the underlying open-source codebase completely in Kotlin.

This developer preview version of Amplify Android is layered on the [AWS SDK for Kotlin](https://aws.amazon.com/sdk-for-kotlin), which was released as Developer Preview last year. This allows for access to the AWS SDK for Kotlin for a breadth of service-centric APIs.

You can also quickly get started by using our [Photo Sharing Sample App](https://github.com/aws-amplify/amplify-android-samples/tree/main/PhotoSharing).

We deeply appreciate your feedback on this Developer Preview as we work towards our General Availability launch: [GitHub Discussion](https://github.com/aws-amplify/amplify-android/discussions/categories/developer-preview) or [File a Bug Report](https://github.com/aws-amplify/amplify-android/issues/new/choose).
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
To setup and configure your application with Amplify Android (Developer Preview).
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
* [Install and configure Amplify CLI](https://docs.amplify.aws/cli/start/install)
* [Android Studio](https://developer.android.com/studio/index.html#downloads) version 4.0 or higher
* [Android SDK](https://developer.android.com/studio/releases/platforms) API level 24 (Android 7.0) or higher
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
Amplify for Android is distributed as Apache Maven packages. In this section, you'll add the packages and other required directives to your build configuration.

Under **Gradle Scripts**, open **build.gradle (Module: MyAmplifyApp)**.

Add the following lines:

```groovy
android {
compileOptions {
// Support for Java 8 features
coreLibraryDesugaringEnabled true
sourceCompatibility JavaVersion.VERSION_1_8
targetCompatibility JavaVersion.VERSION_1_8
}
}

dependencies {
// Amplify core dependency
implementation 'com.amplifyframework:core:ANDROID_DEVPREVIEW'

// Support for Java 8 features
coreLibraryDesugaring 'com.android.tools:desugar_jdk_libs:1.1.5'
}
```

- Set `coreLibraryDesugaringEnabled`, `sourceCompatibility`, and `targetCompatibility` to allow your application to make use of Java 8 features like Lambda expressions
- Add Amplify Core and Desugaring libraries to the `dependencies` block

Run **Gradle Sync**

Android Studio requires you to sync your project with your new configuration. To do this, click **Sync Now** in the notification bar above the file editor.

![](/images/lib/getting-started/android/set-up-android-studio-sync-gradle.png)

When complete, you will see *CONFIGURE SUCCESSFUL* in the output in the *Build* tab at the bottom of your screen.

![](/images/lib/getting-started/android/set-up-android-studio-configure-successful.png)
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
Congratulations! You've successfully setup Amplify Android (Developer Preview) and are ready to start adding Amplify categories to your application. The following categories are currently supported in Amplify Android (Developer Preview):

* [API (GraphQL)](/lib/graphqlapi/getting-started) - for adding a GraphQL endpoint to your app
* [API (REST)](/lib/restapi/getting-started) - for adding a REST endpoint to your app
* [Authentication](/lib/auth/getting-started) (**limited functionality, see below**) - for managing your users
* [DataStore](/lib/datastore/getting-started) - for making it easier to program for a distributed data store for offline and online scenarios
* [Storage](/lib/storage/getting-started) - store complex objects like pictures and videos to the cloud.

<Callout warning>

Authentication category currently only supports the following APIs:

* Sign Up
* Sign In
* Sign Out
* Fetch Auth Session

</Callout>
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
import android0 from "/src/fragments/lib/devpreview/android/getting_started/10_intro.mdx";

<Fragments fragments={{android: android0}} />

## Goal

import android1 from "/src/fragments/lib/devpreview/android/getting_started/20_goal.mdx";

<Fragments fragments={{android: android1}} />

## Prerequisites

import android2 from "/src/fragments/lib/devpreview/android/getting_started/30_preReq.mdx";

<Fragments fragments={{android: android2}} />

## Install Amplify Libraries

import android3 from "/src/fragments/lib/devpreview/android/getting_started/40_installLib.mdx";

<Fragments fragments={{android: android3}} />

## Next Steps

import android4 from "/src/fragments/lib/devpreview/android/getting_started/50_nextSteps.mdx";

<Fragments fragments={{android: android4}} />
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
export const meta = {
title: `Getting started`,
description: `Learn how to setup and configure your application with Amplify (Developer Preview).`,
};

import android0 from "/src/fragments/lib/devpreview/native_common/getting_started/common.mdx";

<Fragments fragments={{android: android0}} />