Skip to content

Commit 47a9ec0

Browse files
committed
Clean up instructions, add hero image
Signed-off-by: Peter Friese <[email protected]>
1 parent 8048a92 commit 47a9ec0

File tree

2 files changed

+26
-15
lines changed

2 files changed

+26
-15
lines changed
2.03 MB
Loading

Examples/FriendlyFlix/README.md

Lines changed: 26 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# FriendlyFlix
22

3+
![FriendlyFlix, a movie tracker sample app](FriendlyFlix-Hero.png)
4+
35
## Introduction
46

57
This quickstart is a movie tracker app to demonstrate the use of Firebase Data Connect
@@ -24,53 +26,62 @@ Follow these steps to get up and running with Firebase Data Connect locally (i.e
2426
For more detailed instructions,
2527
check out the [official documentation](https://firebase.google.com/docs/data-connect/quickstart-local).
2628

27-
### 1. Connect to your Firebase project
29+
30+
### 1. Create a Firebase project
2831

2932
1. If you haven't already, create a Firebase project.
3033
* In the [Firebase console](https://console.firebase.google.com), click
3134
**Create a project**, then follow the on-screen instructions.
3235

33-
34-
### 2. Get the code for the FriendlyFLix quickstart app
36+
### 2. Get the code for the FriendlyFlix quickstart app
3537

3638
1. Clone this repository to your local machine:
3739
```sh
38-
git clone https://github.com/firebase/data-connect-ios-sdk.git
40+
git clone https://github.com/firebase/data-connect-ios-sdk
3941
```
4042

4143
### 3. Open in Visual Studio Code (VS Code)
4244

4345
1. Open the `data-connect-ios-sdk/Examples/FriendlyFlix` directory in VS Code.
44-
2. Click on the Firebase Data Connect icon on the VS Code sidebar to load the Extension.
46+
2. Click on the **Firebase Data Connect** icon on the VS Code sidebar to load the Firebase Data Connect Extension.
4547
a. Sign in with your Google Account if you haven't already.
46-
3. Click on "Connect a Firebase project" and choose the project where you have set up Data Connect.
47-
4. Click on "Start Emulators" - this should generate the Swift SDK for you and start the emulators.
48+
3. Click on **Connect a Firebase project** and choose the project you created in the first step.
49+
4. Click on **Start emulators**.
4850

4951
### 4. Populate the database
5052
In VS Code, open the `data-connect-ios-sdk/Examples/FriendlyFlix/dataconnect/data_seed.gql` file and click the
51-
`Run (local)` button at the top of the file.
53+
**Run (local)** button at the top of the file.
5254

53-
If youd like to confirm that the data was correctly inserted,
55+
If you'd like to confirm that the data was correctly inserted,
5456
open `data-connect-ios-sdk/Examples/FriendlyFlix/dataconnect/movie-connector/queries.gql` and run the `ListMovies` query.
5557

5658
### 5. Run the app
5759

5860
1. Open `data-connect-ios-sdk/Examples/FriendlyFlix/app/FriendlyFlix/FriendlyFlix.xcodeproj` in Xcode
59-
2. Press the Run button in Xcode to run the sample app on the iOS Simulator.
61+
2. Wait for all packages to be resolved.
62+
3. Select one of the iPhone Simulators as the run destination.
63+
4. Press the **Run** button in Xcode to run the sample app on the iOS Simulator.
64+
65+
> [!Note] If you've used Firebase before, you might be wondering why you didn't have to download the
66+
> `GoogleService-Info.plist` file. This file is only required when connecting your app to a Firebase
67+
> project in the cloud, which you will do in the section.
6068
6169
## Connect to a production instance of CloudSQL
6270

63-
Once you've sucessfully run the app locally, you can set up a production instance of CloudSQL and deploy your Firebase Data Connect schema.
71+
Once you've sucessfully run the app locally, you can set up a production instance of CloudSQL in your Firebase project and deploy your Firebase Data Connect schema.
6472

6573
### 1. Connect to your Firebase project
6674

6775
1. If you haven’t already, add an iOS app to your Firebase project
68-
* In the [Firebase console](https://console.firebase.google.com), click on **+ Add app** to add your project, using `com.google.firebase.samples.FriendlyFlix` as the bundle ID.
76+
* On the [Overview page](https://console.firebase.google.com/project/_/overview) of your Firebase project in the [Firebase console](https://console.firebase.google.com), click the **iOS+** icon to add your project, using `com.google.firebase.samples.FriendlyFlix` as the bundle ID (you can leave the *App nickname* and *App Store ID* blank)
77+
* Click **Register app**.
6978
* Click **Download GoogleService-Info.plist** to obtain your Firebase config file.
7079

7180
2. Move the `GoogleService-Info.plist` config file (downloaded in the previous step) into the root folder of the sample app in the
7281
`data-connect-ios-sdk/Examples/FriendlyFlix/app/FriendlyFlix/FriendlyFlix/GoogleService-Info.plist` directory, replacing the existing `GoogleService-Info.plist` (which contains dummy values).
7382

83+
3. In the Firebase console, finish the **Add Firebase to your Apple app** flow by skipping over steps 3,4, and 5 - these were already done for you.
84+
7485
### 2. Upgrade your Firebase project to Blaze
7586

7687
1. Upgrade your project to the Blaze plan. This lets you create a Cloud SQL
@@ -90,10 +101,10 @@ To be able to sign in to the application, you need to enable Firebase Authentica
90101

91102
### 4. Provision a PostgreSQL database
92103

93-
1. Navigate to the [Data Connect section](https://console.firebase.google.com/u/0/project/_/dataconnect)
104+
1. Navigate to the [Data Connect section](https://console.firebase.google.com/project/_/dataconnect)
94105
of the Firebase console, click on the **Get started** button and follow the setup workflow:
95106

96-
- Select **Create new Cloud SQL instance**
107+
- Select **Create new Cloud SQL instance**, and click **Next*.
97108
- 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 `data-connect-ios-sdk/Examples/FriendlyFlix/dataconnect/dataconnect.yaml` file.
98109
- Fill in the following fields for the **data source**:
99110
- Cloud SQL Instance ID: `fdc-sql`
@@ -118,5 +129,5 @@ To be able to sign in to the application, you need to enable Firebase Authentica
118129

119130
### 6. Run the app
120131

121-
1. In Xcode, select **Product > Schemed > Edit Scheme**, and then disable the check box labeled "useEmulator" to use your production project instead.
132+
1. In Xcode, select **Product > Scheme > Edit Scheme...**, and then disable the check box labeled "useEmulator" in the **Arguments Passed On Launch** section to use your production project instead.
122133
2. Press the Run button in Xcode to run the sample app on the iOS Simulator.

0 commit comments

Comments
 (0)