diff --git a/integration-guides/flutterflow-+-powersync/github-workflow.mdx b/integration-guides/flutterflow-+-powersync/github-workflow.mdx
index fe74ee7..7f86a19 100644
--- a/integration-guides/flutterflow-+-powersync/github-workflow.mdx
+++ b/integration-guides/flutterflow-+-powersync/github-workflow.mdx
@@ -8,7 +8,7 @@ description: "Advanced workflow for users requiring more control."
- Before you begin, it's important that you (or someone on your team) are comfortable with FlutterFlow's workflow for managing custom code in GitHub as documented [here](https://docs.flutterflow.io/customizing-your-app/manage-custom-code-in-github). Using PowerSync with FlutterFlow currently requires dropping down into Dart code and merging code changes using git.
+ Before you begin, it's important that you (or someone on your team) are comfortable with FlutterFlow's workflow for managing custom code in GitHub as documented [here](https://docs.flutterflow.io/customizing-your-app/manage-custom-code-in-github). Using PowerSync with FlutterFlow currently requires dropping down into Dart code and merging code changes using Git.
@@ -20,10 +20,10 @@ Skills needed to use this guide:
* SQL
-Used in conjunction with **FlutterFlow**, PowerSync enables developers to build offline-first apps that are robust in poor network conditions and that have highly responsive frontends while relying on Supabase for their backend. This guide provides instructions for how to configure PowerSync for use with your FlutterFlow project that has Supabase integration enabled.
+Used in conjunction with **FlutterFlow**, PowerSync enables developers to build offline-first apps that are robust in poor network conditions and have highly responsive frontends while relying on Supabase for their backend. This guide provides instructions for configuring PowerSync for use with your FlutterFlow project that has Supabase integration enabled.
- This guide takes just over 1 hour to complete. The bulk of that time is the initial FlutterFlow tutorial.
+ This guide takes just over 1 hour to complete. The bulk of that time is spent on the initial FlutterFlow tutorial.
@@ -40,16 +40,16 @@ Used in conjunction with **FlutterFlow**, PowerSync enables developers to build
## Create Your FlutterFlow Project
-This guide assumes you are starting off by following FlutterFlow's tutorial '[Build a Notes App With FlutterFlow and Supabase](https://docs.flutterflow.io/guides/build-a-notes-app-with-flutterflow-and-supabase)'. Some small changes are required to this tutorial to bring it up to date with the latest Supabase, and to make adding PowerSync simpler:
+This guide assumes you are starting by following FlutterFlow's tutorial '[Build a Notes App With FlutterFlow and Supabase](https://docs.flutterflow.io/guides/build-a-notes-app-with-flutterflow-and-supabase)'. Some small changes are required to bring this tutorial up to date with the latest Supabase and to make adding PowerSync simpler:
-1. Create your `notes` table using the `UUID` type for your `id` column instead of `int` . It's [simpler to work with UUID](/usage/sync-rules/client-id) based primary key columns in PowerSync.
+1. Create your `notes` table using the `UUID` type for your `id` column instead of `int`. It's [simpler to work with UUID](/usage/sync-rules/client-id) based primary key columns in PowerSync.
2. Disable [Row Level Security (RLS)](https://supabase.com/docs/guides/database/postgres/row-level-security) in [Step 3 - Creating the notes table](https://docs.flutterflow.io/guides/build-a-notes-app-with-flutterflow-and-supabase#3.-creating-the-notes-table). Since the FlutterFlow tutorial was published, RLS is now mandatory for new tables created in Supabase. This is for development purposes only — it's important to use RLS in production.
3. Enable insert permissions for the Storage object in [Step 4 - Creating a Storage Bucket](https://docs.flutterflow.io/guides/build-a-notes-app-with-flutterflow-and-supabase#4.-creating-a-storage-bucket-in-supabase-for-storing-images). Without this, users won't be able to upload images.
This can be found under Dashboard -> Storage -> Policies. This policy is a template provided by Supabase.
-4. In [Step 10 - Displaying Data in the UI](https://docs.flutterflow.io/guides/build-a-notes-app-with-flutterflow-and-supabase#step-10), pass the `id` column as a parameter instead of the entire row
+4. In [Step 10 - Displaying Data in the UI](https://docs.flutterflow.io/guides/build-a-notes-app-with-flutterflow-and-supabase#step-10), pass the `id` column as a parameter instead of the entire row.
## Connect Your Project to GitHub
@@ -64,8 +64,8 @@ This can be found under Dashboard -> Storage -> Policies. This policy is a templ
CREATE PUBLICATION powersync FOR TABLE notes;
```
-1. Connect PowerSync to your Supabase environment, as detailed in our [Supabase Guide](/integration-guides/supabase-+-powersync#connect-powersync-to-your-supabase).
-2. Deploy the below Sync Rules:
+2. Connect PowerSync to your Supabase environment, as detailed in our [Supabase Guide](/integration-guides/supabase-+-powersync#connect-powersync-to-your-supabase).
+3. Deploy the below Sync Rules:
```yaml
# Sync-rule docs: https://docs.powersync.com/usage/sync-rules
@@ -92,27 +92,31 @@ All of the work in this section will be performed on the `develop` branch that y
### Install PowerSync
1. Add the [powersync](https://pub.dev/packages/powersync) Dart package to your `pubspec.yaml` file: `powersync: ^0.4.1`
- 1. It's also useful having a decent Logging framework in your app, so we also recommend adding `logging: ^1.1.1`
+ 1. It's also useful to have a decent Logging framework in your app, so we recommend adding `logging: ^1.1.1`
2. Run `flutter pub get` and iteratively resolve any dependency issues, for example updating `flutter_cache_manager: 3.3.0` to `flutter_cache_manager: ^3.3.0`
1. See [this commit](https://github.com/powersync-ja/powersync-flutterflow-notes-demo/commit/3e5864b9eb41f11600c3a7d595822d50ec2074a1#diff-8b7e9df87668ffa6a04b32e1769a33434999e54ae081c52e5d943c541d4c0d25) to see exactly which dependencies we had to resolve.
- Note: The FlutterFlow team are always updating their platform, so the exact dependencies that you will need to update may differ.
+ Note: The FlutterFlow team is always updating their platform, so the exact dependencies that you will need to update may differ.
### Import Helper Functions
-1. Create a new file`lib/powersync/powersync.dart` and copy the contents of this file:
+1. Create a new file `lib/powersync/powersync.dart` and copy the contents of this file:
[https://github.com/powersync-ja/powersync-flutterflow-notes-demo/blob/powersync/lib/powersync/powersync.dart](https://github.com/powersync-ja/powersync-flutterflow-notes-demo/blob/powersync/lib/powersync/powersync.dart)
-1. Replace the default value of `powersyncUrl` on line 12 with the value of your PowerSync Service Instance — you can obtain this by opening your Instance properties and copying the value of "Instance URL":
+2. Replace the default value of `powersyncUrl` on line 12 with the value of your PowerSync Service Instance — you can obtain this by opening your Instance properties and copying the value of "Instance URL":
-2. Make the following changes in `lib/main.dart` :
- 1. Add the following imports:`import 'package:flutter/foundation.dart';` `import './powersync/powersync.dart';`
- `import 'package:logging/logging.dart';`
+3. Make the following changes in `lib/main.dart`:
+ 1. Add the following imports:
+ ```dart
+ import 'package:flutter/foundation.dart';
+ import './powersync/powersync.dart';
+ import 'package:logging/logging.dart';
+ ```
2. Add the below snippet and test query immediately before `runApp(MyApp())`:
```dart
@@ -134,7 +138,7 @@ Import the following file into your project, it should be located in `lib/powers
### Smoke Test
-At this point, you can launch your app using `flutter run` and you should see some 'notes' rows from your Supabase being printed out on the console! Something like this:
+At this point, you can launch your app using `flutter run`, and you should see some 'notes' rows from your Supabase being printed out on the console! Something like this:
```js
I/flutter (27958): [powersync-supabase] INFO: 2023-10-23 14:23:59.408889: test_query results = [{id: 4aeaabcd-4143-438d-a49b-903e051ec4bc, id:1: 4aeaabcd-4143-438d-a49b-903e051ec4bc, created_at: 2023-10-23 13:26:34.436Z, title: first note, note: success!, image_link: https://xyz.supabase.co/storage/v1/object/public/notes/users/uploads/1698089188788000.png}, {id: 56e99a0f-3e47-4d12-8fbe-5cb2b45da8ec, id:1: 56e99a0f-3e47-4d12-8fbe-5cb2b45da8ec, created_at: 2023-10-23 13:27:51.015Z, title: second note, note: workes :) , image_link: https://xyz.supabase.co/storage/v1/object/public/notes/users/uploads/1698089268369000.png}]
@@ -150,22 +154,22 @@ Import the following 'notes' model into your project:
### Connect Your UI
-Generally speaking, you'll want to replace any Supabase calls in your UI to use the newly implemented methods from the appropriate models defined in the previous step.
+Generally speaking, you'll want to replace any Supabase calls in your UI with the newly implemented methods from the appropriate models defined in the previous step.
-In this app, we need to update three pages: `home_list_page`, `note_display_page` and `create_note_page`. It's recommended to do these one at a time.
+In this app, we need to update three pages: `home_list_page`, `note_display_page`, and `create_note_page`. It's recommended to do these one at a time.
#### Notes Display Page
Copy the changes from [this commit](https://github.com/powersync-ja/powersync-flutterflow-notes-demo/commit/ca4636e687843b6709aff77d1f630508b1247a9e) into your notes display page.
- This is a big milestone. At this point, force-quit your app, place your test device into airplane mode and relaunch your app. You should see your notes page being populated — all from your local SQLite database
+ This is a big milestone. At this point, force-quit your app, place your test device into airplane mode, and relaunch your app. You should see your notes page being populated — all from your local SQLite database.
-Run your app and verify whether you can launch and see your notes list without connectivity (i.e. in offline mode).
+Run your app and verify whether you can launch and see your notes list without connectivity (i.e., in offline mode).
Then repeat the steps for the note display and create note pages ([link to commit](https://github.com/powersync-ja/powersync-flutterflow-notes-demo/commit/86d0c3827679b5b2357a420d49ccca2c543360b7)).
## Additional Resources
-For more information, explore [the PowerSync docs](/intro/powersync-overview) or join us on [our community Discord](https://discord.gg/powersync) where our team is always available to answer questions.
+For more information, explore [the PowerSync docs](/intro/powersync-overview) or join us on [our community Discord](https://discord.gg/powersync) where our team is always available to answer questions.
\ No newline at end of file
diff --git a/mint.json b/mint.json
index b1249f2..9c70c42 100644
--- a/mint.json
+++ b/mint.json
@@ -252,7 +252,8 @@
"integration-guides/flutterflow-+-powersync",
"integration-guides/flutterflow-+-powersync/flutter-web",
"integration-guides/flutterflow-+-powersync/full-text-search",
- "integration-guides/flutterflow-+-powersync/powersync-+-flutterflow-legacy"
+ "integration-guides/flutterflow-+-powersync/powersync-+-flutterflow-legacy",
+ "integration-guides/flutterflow-+-powersync/github-workflow"
]
},
"integration-guides/railway-+-powersync",
@@ -376,7 +377,9 @@
},
{
"group": "",
- "pages": ["tutorials/overview"]
+ "pages": [
+ "tutorials/overview"
+ ]
},
{
"group": "Client",
@@ -424,7 +427,7 @@
"resources/troubleshooting",
"resources/troubleshooting/error-codes"
]
- },
+ },
{
"group": "Usage & Billing",
"pages": [