Skip to content

Commit 91e0914

Browse files
enhance README: reorganize setup instructions for PowerSync, swopping the order of setting up PowerSync through the dashboard and cli. Also added quick access links for Supabase settings
1 parent f19d5a8 commit 91e0914

1 file changed

Lines changed: 27 additions & 21 deletions

File tree

README.md

Lines changed: 27 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,27 @@ If you prefer using the Supabase CLI, you can set up your project as follows:
108108
You can set up your PowerSync instance using either the Dashboard or CLI approach:
109109

110110
<details>
111-
<summary><strong>Option 1: Using PowerSync CLI</strong></summary>
111+
<summary><strong>Option 1: Setup using the PowerSync Dashboard</strong></summary>
112+
113+
If you prefer using the web interface:
114+
115+
1. In the <a href="https://powersync.journeyapps.com/" target="_blank" rel="noopener noreferrer">PowerSync dashboard</a>, create a new PowerSync instance:
116+
- Right-click on 'PowerSync Project' in the project tree on the left and click "Create new instance"
117+
- Pick a name for the instance e.g. "PowerSyncDemoInstance" and proceed.
118+
119+
2. In the "Edit Instance" dialog that follows, click on the "Connections" tab:
120+
- Click on the "+" button to create a new database connection.
121+
- Input the credentials from the project you created in Supabase. In the Supabase dashboard, under your project you can go to "Project Settings" and then "Database" and choose "URI" under "Connection string", **untick the "Use connection pooling" option** to use the direct connection, and then copy & paste the connection string into the PowerSync dashboard "URI" field, and then enter your database password at the "Password" field.
122+
- Click the "Test connection" button and you should see "Connection success!"
123+
124+
3. Click on the "Credentials" tab of the "Edit Instance" dialog:
125+
- Tick the "Use Supabase Auth" checkbox and configure the JWT secret.
126+
- Click "Save" to save all the changes to your PowerSync instance. The instance will now be deployed — this may take a minute or two.
127+
128+
</details>
129+
130+
<details>
131+
<summary><strong>Option 2: Setup using the PowerSync CLI</strong></summary>
112132

113133
See <a href="https://docs.powersync.com/usage/tools/cli" target="_blank" rel="noopener noreferrer">PowerSync CLI docs</a>.
114134

@@ -151,26 +171,6 @@ Follow the prompts to configure:
151171
152172
</details>
153173

154-
<details>
155-
<summary><strong>Option 2: Using PowerSync Dashboard</strong></summary>
156-
157-
If you prefer using the web interface:
158-
159-
1. In the <a href="https://powersync.journeyapps.com/" target="_blank" rel="noopener noreferrer">PowerSync dashboard</a>, create a new PowerSync instance:
160-
- Right-click on 'PowerSync Project' in the project tree on the left and click "Create new instance"
161-
- Pick a name for the instance e.g. "PowerSyncDemoInstance" and proceed.
162-
163-
2. In the "Edit Instance" dialog that follows, click on the "Connections" tab:
164-
- Click on the "+" button to create a new database connection.
165-
- Input the credentials from the project you created in Supabase. In the Supabase dashboard, under your project you can go to "Project Settings" and then "Database" and choose "URI" under "Connection string", **untick the "Use connection pooling" option** to use the direct connection, and then copy & paste the connection string into the PowerSync dashboard "URI" field, and then enter your database password at the "Password" field.
166-
- Click the "Test connection" button and you should see "Connection success!"
167-
168-
3. Click on the "Credentials" tab of the "Edit Instance" dialog:
169-
- Tick the "Use Supabase Auth" checkbox and configure the JWT secret.
170-
- Click "Save" to save all the changes to your PowerSync instance. The instance will now be deployed — this may take a minute or two.
171-
172-
</details>
173-
174174
## 3. Deploy Sync Rules
175175

176176
<details>
@@ -207,6 +207,12 @@ VITE_POWERSYNC_URL=
207207
### How to get these values:
208208

209209
**VITE_SUPABASE_URL & VITE_SUPABASE_ANON_KEY:**
210+
211+
**Quick Access:** For convenience, you can access both settings directly:
212+
- [API Settings & URL](https://supabase.com/dashboard/project/_/settings/api)
213+
- [API Keys](https://supabase.com/dashboard/project/_/settings/api-keys)
214+
215+
**Detailed Instructions:**
210216
1. Go to your <a href="https://app.supabase.com" target="_blank" rel="noopener noreferrer">Supabase Dashboard</a>
211217
2. Select your project
212218
3. For the URL: Navigate to Project Settings → Data API and copy the "Project URL" for `VITE_SUPABASE_URL`

0 commit comments

Comments
 (0)