-
Notifications
You must be signed in to change notification settings - Fork 7.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
7fa7803
commit 609e504
Showing
1 changed file
with
74 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
# 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. Create a New Data Connect Service and Cloud SQL Instance | ||
|
||
1. Open [Firebase Data Connect](https://console.firebase.google.com/u/0/project/_/dataconnect) in | ||
your project in Firebase Console and select Get Started. | ||
2. Create a new Data Connect service and a Cloud SQL instance. Ensure the Blaze plan is active. | ||
Pricing details can be found at [Firebase Pricing](https://firebase.google.com/pricing). | ||
3. Select your server region, if you wish to use vector search, make sure to select `us-central1` region. | ||
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). | ||
|
||
### 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. | ||
1. (Private Preview only) Checkout the `fdc-quickstart` branch and open the project in Android Studio. | ||
1. Open the a terminal window and initialize your Firebase project with `firebase init dataconnect`. | ||
1. Overwrite only dataconnect.yaml when prompted, do not overwrite any other dataconnect files. | ||
(Optional): If you intend on using other Firebase features, run `firebase init` instead, and select both DataConnect options as well as any feature you intend to use. | ||
1. Allow domains for Firebase Auth in your [project console](https://console.firebase.google.com/project/_/authentication/settings) (e.g. http://127.0.0.1). | ||
|
||
### 4. Running queries and mutations in VS Code | ||
The VSCode Firebase Extension allows you to generate Firebase Data Connect SDK code, run queries/mutations, and deploy Firebase Data Connect with a click. Alternatively, see below for CLI commands. | ||
|
||
1. Install [VS Code](https://code.visualstudio.com/). | ||
2. Download the [Firebase extension](https://firebasestorage.googleapis.com/v0/b/firemat-preview-drop/o/vsix%2Ffirebase-vscode-latest.vsix?alt=media) and [install](https://code.visualstudio.com/docs/editor/extension-marketplace#_install-an-extension) it. | ||
3. Open this quickstart in VS code, and in the left pane of the Firebase extension, and log in with your Firebase account. | ||
(Optional): If your Firebase project was not initialized in the last section, you can click `Run firebase init` and select `Data Connect` to initialize. | ||
4. Click on deploy to deploy your schema to your cloud SQL instance. Or run `firebase deploy --only dataconnect` (this will also activate vectors search if it's enabled in the schema). | ||
5. Running the VSCode extension should automatically start the DataConnect emulators. If you see an emulators error, try running `firebase emulators:start dataconnect` manually. | ||
|
||
Now you should be able to deploy your schema, run mutations/queries, generate SDK code, and view your application locally. | ||
|
||
### 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 | ||
- [ ] Add a new review | ||
- [ ] Update a review | ||
- [ ] Delete a review | ||
- [ ] Actors | ||
- [ ] Show actor profile | ||
- [ ] Mark actor as favorite | ||
- [ ] Error handling | ||
- (Some errors may cause the app to crash at the moment) |