Skip to content

Commit f5fa115

Browse files
fix(README): correct formatting and update options in Getting Started section
1 parent 0739efe commit f5fa115

File tree

1 file changed

+42
-42
lines changed

1 file changed

+42
-42
lines changed

README.md

Lines changed: 42 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,23 @@ A template Vite, TS, React, PowerSync and Supabase project to get you started qu
44

55
## Getting Started
66

7-
You have 3 options to get started with this template.
7+
You have 4 options to get started with this template.
88
We recommend using the first option for a quick start.
99

1010
1. Generate a repository from this [template](https://github.com/powersync-community/vite-react-ts-powersync-supabase/generate)
1111
2. Use [degit](https://github.com/Rich-Harris/degit) to scaffold the project:
1212

13-
```bash
14-
npx degit powersync-community/vite-react-ts-powersync-supabase
15-
```
13+
```bash
14+
npx degit powersync-community/vite-react-ts-powersync-supabase
15+
```
1616

1717
> **Note**: `degit` is a tool that downloads the latest version of a repository without the git history, giving you a clean starting point. Add a second argument to specify your project name (e.g., my-app).
1818
1919
3. Clone the repository directly and install dependencies:
2020

21-
```bash
22-
git clone https://github.com/powersync-community/vite-react-ts-powersync-supabase.git
23-
```
21+
```bash
22+
git clone https://github.com/powersync-community/vite-react-ts-powersync-supabase.git
23+
```
2424

2525
4. Start the project using [bolt.new](https://bolt.new):
2626

@@ -33,11 +33,11 @@ git clone https://github.com/powersync-community/vite-react-ts-powersync-supabas
3333

3434
After cloning the repository, navigate to the project directory and install the dependencies:
3535

36-
```bash
37-
cd vite-react-ts-powersync-supabase
38-
npm install
39-
npm run dev
40-
```
36+
```bash
37+
cd vite-react-ts-powersync-supabase
38+
npm install
39+
npm run dev
40+
```
4141

4242
## Setup Backend
4343

@@ -74,53 +74,53 @@ You can set up your PowerSync instance using either the Dashboard or CLI approac
7474
If you don't have a PowerSync account yet, [sign up here](https://accounts.journeyapps.com/portal/powersync-signup).
7575

7676
1. **Get your Personal Access Token:**
77-
- Go to the [PowerSync dashboard](https://powersync.journeyapps.com/)
78-
- Press `Ctrl + Shift + P` (or `Cmd + Shift + P` on Mac)
79-
- Search for "Create Personal Access Token"
80-
- Give it "owner" policy and a descriptive label
81-
- Copy the generated token
77+
- Go to the [PowerSync dashboard](https://powersync.journeyapps.com/)
78+
- Press `Ctrl + Shift + P` (or `Cmd + Shift + P` on Mac)
79+
- Search for "Create Personal Access Token"
80+
- Give it "owner" policy and a descriptive label
81+
- Copy the generated token
8282

8383
2. **Initialize the CLI and authenticate:**
84-
```bash
85-
npx powersync init
86-
```
87-
Paste your Personal Access Token when prompted.
84+
```bash
85+
npx powersync init
86+
```
87+
Paste your Personal Access Token when prompted.
8888

8989
3. **Create a new PowerSync instance:**
90-
```bash
91-
npx powersync instance create
92-
```
93-
Follow the prompts to configure:
94-
- Instance name (e.g., "supabase-staging")
95-
- Region (e.g., "EU")
96-
- Database connection details from your Supabase project (use the **direct connection**, not pooling)
97-
- When asked about Supabase auth, answer:
98-
- `? Are you using Supabase auth? Yes`
99-
- `? Do you want to add audiences? No`
90+
```bash
91+
npx powersync instance create
92+
```
93+
Follow the prompts to configure:
94+
- Instance name (e.g., "supabase-staging")
95+
- Region (e.g., "EU")
96+
- Database connection details from your Supabase project (use the **direct connection**, not pooling)
97+
- When asked about Supabase auth, answer:
98+
- `? Are you using Supabase auth? Yes`
99+
- `? Do you want to add audiences? No`
100100

101101
4. **Deploy sync rules:**
102-
```bash
103-
npx powersync instance sync-rules deploy -f sync-rules.yaml
104-
```
102+
```bash
103+
npx powersync instance sync-rules deploy -f sync-rules.yaml
104+
```
105105

106-
> After deploying sync rules via CLI, the changes might not be reflected in the dashboard. If you want to see them in the dashboard, simply copy the contents of your `sync-rules.yaml` file and paste them into the dashboard's sync-rules editor, then redeploy.
106+
> After deploying sync rules via CLI, the changes might not be reflected in the dashboard. If you want to see them in the dashboard, simply copy the contents of your `sync-rules.yaml` file and paste them into the dashboard's sync-rules editor, then redeploy.
107107
108108
#### Option 2: Using PowerSync Dashboard
109109

110110
If you prefer using the web interface:
111111

112112
1. In the [PowerSync dashboard](https://powersync.journeyapps.com/), create a new PowerSync instance:
113-
- Right-click on 'PowerSync Project' in the project tree on the left and click "Create new instance"
114-
- Pick a name for the instance e.g. "Yjs Demo Test" and proceed.
113+
- Right-click on 'PowerSync Project' in the project tree on the left and click "Create new instance"
114+
- Pick a name for the instance e.g. "Yjs Demo Test" and proceed.
115115

116116
2. In the "Edit Instance" dialog that follows, click on the "Connections" tab:
117-
- Click on the "+" button to create a new database connection.
118-
- 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.
119-
- Click the "Test connection" button and you should see "Connection success!"
117+
- Click on the "+" button to create a new database connection.
118+
- 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.
119+
- Click the "Test connection" button and you should see "Connection success!"
120120

121121
3. Click on the "Credentials" tab of the "Edit Instance" dialog:
122-
- Tick the "Use Supabase Auth" checkbox and configure the JWT secret.
123-
- Click "Save" to save all the changes to your PowerSync instance. The instance will now be deployed — this may take a minute or two.
122+
- Tick the "Use Supabase Auth" checkbox and configure the JWT secret.
123+
- Click "Save" to save all the changes to your PowerSync instance. The instance will now be deployed — this may take a minute or two.
124124

125125
### 3. Deploy Sync Rules
126126

0 commit comments

Comments
 (0)