GraphQL starter application using AWS AppSync
AWS Mobile App Sync Starter App for Android
This is a Starter application for using the Sample app in the AWS AppSync console when building your GraphQL API. The Sample app creates a GraphQL schema and provisions Amazon DynamoDB resources, then connects them appropriately with Resolvers. The application demonstrates GraphQL Mutations, Queries, and Offline support using AWS AppSync. You can use this for learning purposes or adapt either the application or the GraphQL Schema to meet your needs.
Navigate to the AWS AppSync console using the URL: http://console.aws.amazon.com/appsync/home
Click on Create API
and select the Event App
under the sample project
in the bottom pane, and select Start
. Enter a API name of your choice. Click Create
.
Clone this repository:
git clone https://github.com/aws-samples/aws-mobile-appsync-events-starter-android.git
Open Android Studio, choose Import project
navigate to the repository folder that was cloned and select open.
Ensure that the project's build.gradle
has the following dependency in the build script:
classpath 'com.amazonaws:aws-android-sdk-appsync-gradle-plugin:2.7.+'
apply plugin: 'com.android.application'
apply plugin: 'com.amazonaws.appsync'
android {
// Typical items
}
dependencies {
// Typical dependencies
implementation 'com.amazonaws:aws-android-sdk-appsync:2.7.+'
implementation 'org.eclipse.paho:org.eclipse.paho.client.mqttv3:1.2.0'
implementation 'org.eclipse.paho:org.eclipse.paho.android.service:1.1.1'
}
<service>
entry under <application>
for MqttService
to use subscriptions: <uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
<uses-permission android:name="android.permission.WAKE_LOCK" />
<uses-permission android:name="android.permission.READ_PHONE_STATE" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
<!--other config-->
<application>
<service android:name="org.eclipse.paho.android.service.MqttService" />
<!--other config-->
</application>
Inside Android Studio, choose the menu Tools > Android > Sync Project with Gradle Files
to ensure gradle is up to date and wait until this completes.
Wait until the progress bar at the top has completed deploying your resources. Then from the integration page of your GraphQL API (you can click the name you entered in the left hand navigation).
On this same page, select Android
at the bottom to download your awsconfiguration.json
configuration file by clicking the Download Config button. Replace the awsconfiguration.json
file in the src/main/res/raw
folder of your app with the file you just downloaded.
Java code is generated from a schema file (./app/src/main/graphql/com/amazonaws/demo/appsync/schema.json
) and a .graphql file (/app/src/main/graphql/com/amazonaws/demo/appsync/events.graphql
) based on your API. The generated source is in the ./app/build/generated/source/appsync
folder of this project after a build is completed.
If you update your schema in the future, you should use the AWS Amplify CLI codegen feature to automatically download and update your queries, mutations, subscriptions and the schema. For a tutorial of this, click here.
ListEventsActivity.java
file lists all the events accessible to the user. It returns data from the offline cache first if available and later fetches it from remote to update the local cache.ViewEventActivity.java
file lists information about an event and allows new comments to be added. New comments to the event are added while the user is viewing the event via subscriptions.AddEventActivity.java
file creates a new event using the details entered on screen.We use AppSync Android SDK GitHub issues for tracking questions, bugs, and feature requests.
This sample code is made available under the MIT-0 license. See the LICENSE file.