Skip to content

Commit

Permalink
Update ReadME. Fix case for extension dependency
Browse files Browse the repository at this point in the history
  • Loading branch information
hlshen committed Sep 27, 2024
1 parent 3e431d6 commit 1e6e2de
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 5 deletions.
15 changes: 11 additions & 4 deletions firebase-vscode/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# Firebase Data Connect for VSCode

The Firebase Data Connect extension provides a suite of tools aimed to assist developers in their Data Connect development workflow.
The Firebase Data Connect extension provides a suite of tools to assist developers in their Data Connect development workflow.

## Language Features

The extension runs a Graphql Language Server that checks for syntax and compile time errors in your Data Connect code. Additionally, it provides auto-complete suggestions specific to Data Connect.

The extension will automatically generate GraphQL types based on your schema, viewable in your Explorer panel.

## Execution
## Query Execution

Within your GraphQL files, you’ll see in-line Codelenses that can help you create and test operations.

Expand All @@ -18,10 +18,17 @@ To execute an operation, click on `Run Local` or `Run Production`. This will exe

Note: You’ll need to start the Data Connect emulator in order to execute operations locally.

## Generated SDK
## Strongly typed SDK Generation

The extension can help you set-up SDK generation with a simple folder selection. Once you’ve selected an app folder of your choice, client code will start generating automatically.

## Local Emulator
You can start a local emulator to test your queries on your application.

## Deploy to Production

Once you’ve written and tested out your schema and operations, deploy your code to your production Data Connect instance.
Once you’ve tested the schema and operations and ran the generated SDK in your app, deploy your schema, operation and data to your Cloud SQL instance in production.


### Documentation
Please see [Getting started with Firebase Data Connect](https://firebase.google.com/docs/data-connect/quickstart).
2 changes: 1 addition & 1 deletion firebase-vscode/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"Other"
],
"extensionDependencies": [
"graphql.vscode-graphql-syntax"
"GraphQL.vscode-graphql-syntax"
],
"activationEvents": [
"onStartupFinished",
Expand Down

0 comments on commit 1e6e2de

Please sign in to comment.