Add Firebase Data Connect quickstart

build.gradle.kts

@@ -9,6 +9,7 @@ plugins {
     id("com.google.firebase.firebase-perf") version "1.4.2" apply false
     id("androidx.navigation.safeargs") version "2.8.0" apply false
     id("com.github.ben-manes.versions") version "0.51.0" apply true
+    id("org.jetbrains.kotlin.plugin.compose") version "2.0.20" apply false
 }
 
 allprojects {

copy_mock_google_services_json.sh

@@ -12,6 +12,7 @@ cp mock-google-services.json auth/app/google-services.json
 cp mock-google-services.json config/app/google-services.json
 cp mock-google-services.json crash/app/google-services.json
 cp mock-google-services.json database/app/google-services.json
+cp mock-google-services.json dataconnect/app/google-services.json
 cp mock-google-services.json dynamiclinks/app/google-services.json
 cp mock-google-services.json firestore/app/google-services.json
 cp mock-google-services.json functions/app/google-services.json

dataconnect/.gitignore

@@ -0,0 +1,17 @@
+*.iml
+.gradle
+/local.properties
+/.idea/caches
+/.idea/libraries
+/.idea/modules.xml
+/.idea/workspace.xml
+/.idea/navEditor.xml
+/.idea/assetWizardSettings.xml
+.DS_Store
+/build
+/captures
+.externalNativeBuild
+.cxx
+local.properties
+.dataconnect/
+.firebaserc

dataconnect/README.md

@@ -0,0 +1,97 @@
+# Firebase Data Connect Quickstart
+
+## Introduction
+
+This quickstart is a movie review app to demonstrate the use of Firebase Data Connect
+ with a Cloud SQL database.
+For more information about Firebase Data Connect visit [the docs](https://firebase.google.com/docs/data-connect/).
+
+## Getting Started
+
+Follow these steps to get up and running with Firebase Data Connect. For more detailed instructions,
+check out the [official documentation](https://firebase.google.com/docs/data-connect/quickstart).
+
+### 1. Connect to your Firebase project
+
+1. If you haven't already, create a Firebase project.
+    1. In the [Firebase console](https://console.firebase.google.com), click
+        **Add project**, then follow the on-screen instructions.
+
+2. Upgrade your project to the Blaze plan. This lets you create a Cloud SQL
+    for PostgreSQL instance.
+
+    > Note: Though you set up billing in your Blaze upgrade, you won't be
+    charged for usage of Firebase Data Connect or the
+    [default Cloud SQL for PostgreSQL configuration](https://firebase.google.com/docs/data-connect/#pricing)
+    during the preview.
+
+3. Navigate to the [Data Connect section](https://console.firebase.google.com/u/0/project/_/dataconnect)
+    of the Firebase console, click on the "Get Started" button and follow the setup workflow:
+     - Select a location for your Cloud SQL for PostgreSQL database (this sample uses `us-central1`). If you choose a different location, you'll also need to change the `quickstart-android/dataconnect/dataconnect/dataconnect.yaml` file. 
+     - Select the option to create a new Cloud SQL instance and fill in the following fields:
+       - Service ID: `dataconnect`
+       - Cloud SQL Instance ID: `fdc-sql`
+       - Database name: `fdcdb`
+4. Allow some time for the Cloud SQL instance to be provisioned. After it's provisioned, the instance
+   can be managed in the [Cloud Console](https://console.cloud.google.com/sql).
+
+5. If you haven’t already, add an Android app to your Firebase project, with the android package name `com.google.firebase.example.dataconnect`. Download and then add the Firebase Android configuration file (`google-services.json`) to your app:
+    1. Click **Download google-services.json** to obtain your Firebase Android config file.
+    2. Move your config file into the `quickstart-android/dataconnect/app` directory.
+
+### 2. Set Up Firebase CLI
+
+Ensure the Firebase CLI is installed and up to date:
+
+```bash
+npm install -g firebase-tools
+```
+
+### 3. Cloning the repository
+This repository contains the quickstart to get started with the functionalities of Data Connect.
+
+1. Clone this repository to your local machine:
+   ```sh
+   git clone https://github.com/firebase/quickstart-android.git
+   ```
+
+2. (Private Preview only) Checkout the `fdc-quickstart` branch (`git checkout fdc-quickstart`)
+   and open the project in Android Studio.
+
+### 4. Deploy the service to Firebase and generate SDKs
+
+1. Open the `quickstart-android/dataconnect/dataconnect` directory and deploy the schema with
+    the following command:
+    ```bash
+    firebase deploy
+    ```
+2. Once the deploy is complete, you should be able to see the movie schema in the
+ [Data Connect section](https://console.firebase.google.com/u/0/project/_/dataconnect)
+ of the Firebase console.
+
+3. Generate the Kotlin SDK by running:
+   ```bash
+   firebase dataconnect:sdk:generate
+   ```
+
+### 5. Populating the database
+1. Run `1_movie_insert.gql`, `2_actor_insert.gql`, `3_movie_actor_insert.gql`, and `4_user_favorites_review_insert.gql` files in the `./dataconnect` directory in order using the VS code extension,
+
+### 6. Running the app
+
+Press the Run button in Android Studio to run the sample app on your device.
+
+## 🚧 Work in Progress
+
+This app is still missing some features which will be added before Public Preview:
+
+- [ ] Search
+- [ ] Movie review
+  - [x] Add a new review 
+  - [ ] Update a review
+  - [ ] Delete a review
+- [x] Actors
+  - [x] Show actor profile
+  - [x] Mark actor as favorite
+- [ ] Error handling
+  Some errors may cause the app to crash, especially if there's no user logged in. 

dataconnect/app/.gitignore

@@ -0,0 +1 @@
+/build

dataconnect/app/build.gradle.kts

@@ -0,0 +1,84 @@
+plugins {
+    alias(libs.plugins.android.application)
+    alias(libs.plugins.jetbrains.kotlin.android)
+    alias(libs.plugins.kotlin.serialization)
+    alias(libs.plugins.google.services)
+    alias(libs.plugins.compose.compiler)
+}
+
+android {
+    namespace = "com.google.firebase.example.dataconnect"
+    compileSdk = 34
+
+    defaultConfig {
+        applicationId = "com.google.firebase.example.dataconnect"
+        minSdk = 23
+        targetSdk = 34
+        versionCode = 1
+        versionName = "1.0"
+
+        testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
+        vectorDrawables {
+            useSupportLibrary = true
+        }
+    }
+
+    buildTypes {
+        release {
+            isMinifyEnabled = false
+            proguardFiles(
+                getDefaultProguardFile("proguard-android-optimize.txt"),
+                "proguard-rules.pro"
+            )
+        }
+    }
+    compileOptions {
+        sourceCompatibility = JavaVersion.VERSION_1_8
+        targetCompatibility = JavaVersion.VERSION_1_8
+    }
+    kotlinOptions {
+        jvmTarget = "1.8"
+    }
+    buildFeatures {
+        compose = true
+    }
+    composeOptions {
+        kotlinCompilerExtensionVersion = "1.5.13"
+    }
+    packaging {
+        resources {
+            excludes += "/META-INF/{AL2.0,LGPL2.1}"
+        }
+    }
+    sourceSets.getByName("main") {
+        java.srcDirs("build/generated/sources")
+    }
+}
+
+dependencies {
+
+    implementation(libs.androidx.core.ktx)
+    implementation(libs.androidx.lifecycle.runtime.ktx)
+    implementation(libs.androidx.lifecycle.viewmodel.compose)
+    implementation(libs.androidx.activity.compose)
+    implementation(platform(libs.androidx.compose.bom))
+    implementation(libs.androidx.ui)
+    implementation(libs.androidx.ui.graphics)
+    implementation(libs.androidx.ui.tooling.preview)
+    implementation(libs.androidx.material3)
+    implementation(libs.compose.navigation)
+    implementation(libs.androidx.lifecycle.runtime.compose.android)
+    implementation(libs.coil.compose)
+
+    // Firebase dependencies
+    implementation(libs.firebase.auth)
+    implementation(libs.firebase.dataconnect)
+
+    testImplementation(libs.junit)
+    androidTestImplementation(libs.androidx.junit)
+    androidTestImplementation(libs.androidx.espresso.core)
+    androidTestImplementation(platform(libs.androidx.compose.bom))
+    androidTestImplementation(libs.androidx.ui.test.junit4)
+    debugImplementation(libs.androidx.ui.tooling)
+    debugImplementation(libs.androidx.ui.test.manifest)
+}

dataconnect/app/proguard-rules.pro

@@ -0,0 +1,21 @@
+# Add project specific ProGuard rules here.
+# You can control the set of applied configuration files using the
+# proguardFiles setting in build.gradle.
+#
+# For more details, see
+#   http://developer.android.com/guide/developing/tools/proguard.html
+
+# If your project uses WebView with JS, uncomment the following
+# and specify the fully qualified class name to the JavaScript interface
+# class:
+#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
+#   public *;
+#}
+
+# Uncomment this to preserve the line number information for
+# debugging stack traces.
+#-keepattributes SourceFile,LineNumberTable
+
+# If you keep the line number information, uncomment this to
+# hide the original source file name.
+#-renamesourcefileattribute SourceFile

dataconnect/app/src/main/AndroidManifest.xml

@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    xmlns:tools="http://schemas.android.com/tools">
+
+    <uses-permission android:name="android.permission.INTERNET" />
+    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
+
+    <application
+        android:allowBackup="true"
+        android:dataExtractionRules="@xml/data_extraction_rules"
+        android:fullBackupContent="@xml/backup_rules"
+        android:icon="@mipmap/ic_launcher"
+        android:label="@string/app_name"
+        android:roundIcon="@mipmap/ic_launcher_round"
+        android:supportsRtl="true"
+        android:theme="@style/Theme.FirebaseDataConnect"
+        tools:targetApi="31">
+        <activity
+            android:name=".MainActivity"
+            android:exported="true"
+            android:label="@string/app_name"
+            android:theme="@style/Theme.FirebaseDataConnect">
+            <intent-filter>
+                <action android:name="android.intent.action.MAIN" />
+
+                <category android:name="android.intent.category.LAUNCHER" />
+            </intent-filter>
+        </activity>
+    </application>
+
+</manifest>