Skip to content

feat: add fdc readme #811

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Sep 12, 2024
Merged

feat: add fdc readme #811

merged 8 commits into from
Sep 12, 2024

Conversation

HYACCCINT
Copy link
Contributor

No description provided.

Copy link

Doc Tag Diff

This PR makes the following changes to doc tags (0 added, 0 removed, 0 changed):

Copy link

@charlotteliang charlotteliang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks Cynthia!

This repository contains the quickstart to get started with the functionalities of Data Connect.

1. Clone this repository to your local machine.
2. Enable the DataConnect CLI with the command `firebase experiments:enable dataconnect`.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this step is no longer needed, I will update mine as well.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's right. We remove the need to enable experiments


1. Clone this repository to your local machine.
2. Enable the DataConnect CLI with the command `firebase experiments:enable dataconnect`.
3. cd to the `dataconnect` folder, and initialize your Firebase project with `firebase init` and select both DataConnect options. Overwrite only dataconnect.yaml when prompted, do not overwrite any other dataconnect files.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder since you are going to recommend dev to use vscode, maybe just let them open the folder with vscode and then click on the firebase init button which will be less steps for developers

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

but if web developers are used to running CLI separately then i guess it can also stay this way.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can run firebase init dataconnect directly to simplify.

Joe is hiding the second option.

2. cd to the `dataconnect` folder, and initialize your Firebase project with `firebase init dataconnect`. 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.
3. Replace variables in `.env` with your project-specific values.
4. Allow domains for Firebase Auth in your [project console](https://console.firebase.google.com/project/_/authentication/settings) (e.g. http://127.0.0.1).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this still required for localhost?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think auth has localhost by default, but not 127.0.0.1

@HYACCCINT HYACCCINT merged commit 739dc3b into master Sep 12, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants