diff --git a/demos/angular-supabase-todolist/README.md b/demos/angular-supabase-todolist/README.md index 34dd08e6e..59ff23468 100644 --- a/demos/angular-supabase-todolist/README.md +++ b/demos/angular-supabase-todolist/README.md @@ -1,16 +1,15 @@ # PowerSync + Supabase Angular Demo: Todo List -## Note: Alpha Release - -This demo is currently in an alpha release. - ## Overview Demo app demonstrating use of the [PowerSync SDK for Web](https://www.npmjs.com/package/@powersync/web) together with Supabase. -A step-by-step guide on Supabase<>PowerSync integration is available [here](https://docs.powersync.com/integration-guides/supabase-+-powersync). +## Run Demo -## Quick Start +Prerequisites: +* To run this demo, you need to have properly configured Supabase and PowerSync projects. Follow the instructions in our Supabase<>PowerSync integration guide: + * [Configure Supabase](https://docs.powersync.com/integration-guides/supabase-+-powersync#configure-supabase) + * [Configure PowerSync](https://docs.powersync.com/integration-guides/supabase-+-powersync#configure-powersync) 1. Run `pnpm install` 2. Create a `.env` file by copying the template `cp .env.template .env` diff --git a/demos/react-native-supabase-todolist/README.md b/demos/react-native-supabase-todolist/README.md index 45a25f49c..9b542cde8 100644 --- a/demos/react-native-supabase-todolist/README.md +++ b/demos/react-native-supabase-todolist/README.md @@ -4,10 +4,13 @@ Demo app demonstrating use of the [PowerSync SDK for React Native](https://www.npmjs.com/package/@powersync/react-native) together with Supabase. -A step-by-step guide on Supabase<>PowerSync integration is available [here](https://docs.powersync.com/integration-guides/supabase-+-powersync). -Follow all the steps until, but not including, [Test Everything (Using Our Demo App)](https://docs.powersync.com/integration-guides/supabase-+-powersync#test-everything-using-our-demo-app). +## Run Demo -## Getting Started +Prerequisites: +* To run this demo, you need to have properly configured Supabase and PowerSync projects. Follow the instructions in our Supabase<>PowerSync integration guide: + * [Configure Supabase](https://docs.powersync.com/integration-guides/supabase-+-powersync#configure-supabase) + * [Configure PowerSync](https://docs.powersync.com/integration-guides/supabase-+-powersync#configure-powersync) +* Follow all the steps until, but not including, [Test Everything (Using Our Demo App)](https://docs.powersync.com/integration-guides/supabase-+-powersync#test-everything-using-our-demo-app). Switch into the demo's directory: diff --git a/demos/react-native-web-supabase-todolist/README.md b/demos/react-native-web-supabase-todolist/README.md index cb24d3640..049aada04 100644 --- a/demos/react-native-web-supabase-todolist/README.md +++ b/demos/react-native-web-supabase-todolist/README.md @@ -6,9 +6,12 @@ This demo app is an extension of the [Supabase Todo List App](../react-native-su To use PowerSync in your own React Native for Web project, additional config is required. This is detailed in our docs [here](https://docs.powersync.com/client-sdk-references/react-native-and-expo/react-native-web-support). -To run this demo, follow these instructions: +## Run Demo -## Running this demo +Prerequisites: +* To run this demo, you need to have properly configured Supabase and PowerSync projects. Follow the instructions in our Supabase<>PowerSync integration guide: + * [Configure Supabase](https://docs.powersync.com/integration-guides/supabase-+-powersync#configure-supabase) + * [Configure PowerSync](https://docs.powersync.com/integration-guides/supabase-+-powersync#configure-powersync) ### Install dependencies diff --git a/demos/react-supabase-todolist-sync-streams/README.md b/demos/react-supabase-todolist-sync-streams/README.md index d15402f8f..abdf73593 100644 --- a/demos/react-supabase-todolist-sync-streams/README.md +++ b/demos/react-supabase-todolist-sync-streams/README.md @@ -6,7 +6,13 @@ This app is a fork of our [React Supabase Todolist Demo](../react-supabase-todol Sync streams are not a stable PowerSync feature yet, and most users should probably use the stable demo instead. -To use this demo, deploy the following sync streams: +## Run Demo + +Prerequisites: +* To run this demo, you need to have properly configured Supabase and PowerSync projects. Follow the instructions in our Supabase<>PowerSync integration guide: + * [Configure Supabase](https://docs.powersync.com/integration-guides/supabase-+-powersync#configure-supabase) + * [Configure PowerSync](https://docs.powersync.com/integration-guides/supabase-+-powersync#configure-powersync) +* Instead of implementing sync rules per these docs, deploy the following sync streams: ```yaml streams: @@ -20,8 +26,6 @@ config: edition: 2 ``` -## Getting Started - Switch into the demo's directory: ```bash diff --git a/demos/react-supabase-todolist-tanstackdb/README.md b/demos/react-supabase-todolist-tanstackdb/README.md index 8e5ac633a..e7dcef17b 100644 --- a/demos/react-supabase-todolist-tanstackdb/README.md +++ b/demos/react-supabase-todolist-tanstackdb/README.md @@ -4,9 +4,12 @@ Demo app demonstrating use of the [PowerSync SDK for Web](https://www.npmjs.com/package/@powersync/web) together with Supabase and the PowerSync [TanStackDB](https://tanstack.com/db/latest) integration. -A step-by-step guide on Supabase<>PowerSync integration is available [here](https://docs.powersync.com/integration-guides/supabase-+-powersync). +## Run Demo -## Getting Started +Prerequisites: +* To run this demo, you need to have properly configured Supabase and PowerSync projects. Follow the instructions in our Supabase<>PowerSync integration guide: + * [Configure Supabase](https://docs.powersync.com/integration-guides/supabase-+-powersync#configure-supabase) + * [Configure PowerSync](https://docs.powersync.com/integration-guides/supabase-+-powersync#configure-powersync) Switch into the demo's directory: diff --git a/demos/vue-supabase-todolist/README.md b/demos/vue-supabase-todolist/README.md index 35745593b..0724112a6 100644 --- a/demos/vue-supabase-todolist/README.md +++ b/demos/vue-supabase-todolist/README.md @@ -1,22 +1,21 @@ # PowerSync + Supabase Vue Demo: Todo List (TypeScript) -## Note: Beta Release - -The `powersync/vue` package is currently in a beta release. - ## Overview Demo app demonstrating use of the [PowerSync Vue](https://www.npmjs.com/package/@powersync/vue) together with Supabase. -A step-by-step guide through the Supabase<>PowerSync integration is available [here](https://docs.powersync.com/integration-guides/supabase-+-powersync). - ## Recommended Setup - [VS Code](https://code.visualstudio.com/) + [Vue - Official](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (previously Volar) and disable Vetur - Use [vue-tsc](https://github.com/vuejs/language-tools/tree/master/packages/tsc) for performing the same type checking from the command line, or for generating d.ts files for SFCs. -## Getting Started +## Run Demo + +Prerequisites: +* To run this demo, you need to have properly configured Supabase and PowerSync projects. Follow the instructions in our Supabase<>PowerSync integration guide: + * [Configure Supabase](https://docs.powersync.com/integration-guides/supabase-+-powersync#configure-supabase) + * [Configure PowerSync](https://docs.powersync.com/integration-guides/supabase-+-powersync#configure-powersync) Switch into the demo's directory: