# sync-quickstart-android

**Repository Path**: mirrors_twilio/sync-quickstart-android

## Basic Information

- **Project Name**: sync-quickstart-android
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-10-22
- **Last Updated**: 2025-11-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Sync Android Quickstart Application Overview

## Getting Started

Welcome to the Sync Demo application.  This application demonstrates a basic Tic-Tac-Toe client with the ability to make moves by any number of players, by synchronising the game state across the clients.

What you'll minimally need to get started:

- A clone of this repository
- A running instance of the backend quickstart of your choice ([Ruby](https://github.com/TwilioDevEd/sync-quickstart-ruby), [Python](https://github.com/TwilioDevEd/sync-quickstart-python), [Node.js](https://github.com/TwilioDevEd/sync-quickstart-node), [Java](https://github.com/TwilioDevEd/sync-quickstart-java), [C#](https://github.com/TwilioDevEd/sync-quickstart-csharp), or [PHP](https://github.com/TwilioDevEd/sync-quickstart-php)) to issue [Access Tokens](https://www.twilio.com/docs/api/sync/identity-and-access-tokens)

## Building

### Add google-services.json

[Generate google-services.json](https://support.google.com/firebase/answer/7015592?hl=en) file and place it under `sync-quickstart-android/`.

### Wire in your Token Service

Set the value of `ACCESS_TOKEN_SERVICE_URL` in `gradle.properties` file to point to a valid Access-Token server. If you're using one of the quickstarts to provide tokens, you'll probably want to use [`ngrok`](http://ngrok.io) to direct a publicly-accessible URL to your localhost service.

```bash
$ ngrok http localhost:4567
```

Your `gradle.properties` file should look something like this, borrowing from the output of the above.

```
ACCESS_TOKEN_SERVICE_URL=http://9349392.ngrok.io/token
```

You can also pass this address to gradle during the build.

```bash
./gradlew assembleDebug -PACCESS_TOKEN_SERVICE_URL=http://example.com/get-token/
```

### Build

Run `./gradlew assembleDebug` to fetch Twilio Sync SDK files and build application.

### Android Studio

You can import this project into Android Studio and then build as you would ordinarily. The token server setup is still important.

### Optionally setup Firebase Crashlytics

If you want to see crashes reported to crashlytics:
1. [Set up Crashlytics in the Firebase console](https://firebase.google.com/docs/crashlytics/get-started?platform=android#setup-console)

2. In order to see native crashes symbolicated upload symbols into the Firebase console:
```
./gradlew sync-quickstart-android:assembleBUILD_VARIANT
./gradlew sync-quickstart-android:uploadCrashlyticsSymbolFileBUILD_VARIANT
```
for example to upload symbols for `debug` build type run:
```
./gradlew sync-quickstart-android:assembleDebug
./gradlew sync-quickstart-android:uploadCrashlyticsSymbolFileDebug
```

Select "Simulate crash" from the app menu to force an app crash.

[Read more](https://firebase.google.com/docs/crashlytics/upgrade-sdk?platform=android#optional_step_set_up_ndk_crash_reporting) about Android NDK crash reports.