Skip to content

Commit 82ee628

Browse files
author
Mike Barnes
committed
README copy changes
1 parent 304c7c7 commit 82ee628

File tree

1 file changed

+35
-19
lines changed

1 file changed

+35
-19
lines changed

README.md

Lines changed: 35 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,9 @@
44

55
A templated Vite, TS, React, PowerSync and Supabase project to get you started quickly with building offline-first applications with PowerSync and Supabase.
66

7-
## Requirements
8-
9-
| Tool/Service | Version / Info | Notes |
10-
|------------------|----------------------------|--------------------------------------------------------|
11-
| Node.js (via nvm)| `v20.19.0` | Ensure you run `nvm use` to match the project version |
12-
| PowerSync | Active account required | [Sign up here](https://accounts.journeyapps.com/portal/powersync-signup) |
13-
| Supabase | Active project/account | [Sign up here](https://supabase.com/dashboard/sign-up) |
14-
15-
167
# Getting Started
178

18-
You have 4 options to get started with this template. We recommend using the first option for a quick start.
9+
There are a few ways you can use this template. We recommend using the first option for a quick start.
1910

2011
<details>
2112
<summary><strong>1. Generate from template (Recommended)</strong></summary>
@@ -60,22 +51,47 @@ Start the project using [bolt.new](https://bolt.new):
6051

6152
</details>
6253

63-
## Usage
54+
# Usage
55+
56+
There are two ways to run the project:
57+
1. Run the full stack locally. No signups required.
58+
2. Connect your local client to PowerSync Cloud and Supabase.
6459

6560
After cloning the repository, navigate to the project directory and install the dependencies:
6661

6762
```bash
6863
cd vite-react-ts-powersync-supabase
6964
npm install
70-
npm run dev
7165
```
7266

73-
---
67+
## Local Setup
68+
69+
First, copy the environment template file:
70+
```bash
71+
cp .env.local.template .env.local
72+
```
73+
Then run the start-up commands for the various services:
74+
```bash
75+
npm run dev:supabase
76+
npm run dev:powersync
77+
npm run dev:ui
78+
```
79+
80+
Navigate to the local Vite URL e.g. http://localhost:5173/
81+
82+
## Cloud Setup
83+
84+
### Requirements
85+
86+
| Tool/Service | Version / Info | Notes |
87+
|------------------|----------------------------|--------------------------------------------------------|
88+
| PowerSync | Active account required | [Sign up here](https://accounts.journeyapps.com/portal/powersync-signup) |
89+
| Supabase | Active project/account | [Sign up here](https://supabase.com/dashboard/sign-up) |
7490

75-
# Backend Setup
91+
### Backend Setup
7692
This section guides you through setting up the backend using Supabase and PowerSync. Follow the steps below to configure your backend environment.
7793

78-
## 1. Setup Supabase
94+
#### 1. Setup Supabase
7995
Follow these steps to set up your backend with Supabase and PowerSync (Or you can follow the [guide](https://docs.powersync.com/integration-guides/supabase-+-powersync)).
8096

8197
<details>
@@ -104,7 +120,7 @@ If you prefer using the Supabase CLI, you can set up your project as follows:
104120

105121
</details>
106122

107-
## 2. Setup PowerSync Instance and Connect to Supabase
123+
#### 2. Setup PowerSync Instance and Connect to Supabase
108124

109125
You can set up your PowerSync instance using either the Dashboard or CLI approach:
110126

@@ -172,7 +188,7 @@ Follow the prompts to configure:
172188
173189
</details>
174190

175-
## 3. Deploy Sync Rules
191+
#### 3. Deploy Sync Rules
176192

177193
<details>
178194
<summary><strong>Option 1: Using CLI (if you used CLI setup above)</strong></summary>
@@ -190,7 +206,7 @@ The sync rules are already deployed if you followed the CLI setup steps above.
190206

191207
</details>
192208

193-
## 4. Set up environment
209+
#### 4. Set up environment
194210

195211
First, copy the environment template file:
196212
```bash
@@ -223,4 +239,4 @@ VITE_POWERSYNC_URL=
223239
1. Go to your [PowerSync Dashboard](https://powersync.journeyapps.com/)
224240
2. Select your project
225241
3. Navigate to your PowerSync instance
226-
4. Copy the "Instance URL" for `VITE_POWERSYNC_URL`
242+
4. Copy the "Instance URL" for `VITE_POWERSYNC_URL`

0 commit comments

Comments
 (0)