Skip to content

Commit 9c262f3

Browse files
committed
Update READMEs to reflect new way of using demos
1 parent 53d83c9 commit 9c262f3

File tree

18 files changed

+59
-57
lines changed

18 files changed

+59
-57
lines changed

demos/example-capacitor/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ Example demonstrating the use of the [PowerSync SDK for Capacitor](/packages/cap
44

55
To see it in action:
66

7-
1. Make sure to run `pnpm install` and `pnpm build:packages` in the root directory of this repo.
7+
1. `cd` into this directory and run `pnpm install`.
88
2. Copy `.env.local.template` to `.env.local`, and complete the environment variables. You can generate a [temporary development token](https://docs.powersync.com/usage/installation/authentication-setup/development-tokens), or leave blank to test with local-only data.
9-
3. `cd` into this directory and run `pnpm start`.
9+
3. Run `pnpm start`.
1010
4. Open the localhost URL displayed in the terminal output in your browser.
1111

1212
## iOS

demos/example-electron-node/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ In particular:
1818

1919
To see it in action:
2020

21-
1. Make sure to run `pnpm install` and `pnpm build:packages` in the root directory of this repo.
21+
1. Make sure to run `pnpm install` in the demo's directory.
2222
2. Copy `.env.local.template` to `.env.local`, and complete the environment variables. You can generate a [temporary development token](https://docs.powersync.com/usage/installation/authentication-setup/development-tokens), or leave blank to test with local-only data.
2323
The example works with the schema from the [PowerSync + Supabase tutorial](https://docs.powersync.com/integration-guides/supabase-+-powersync#supabase-powersync).
2424
3. `cd` into this directory. In this mono-repo, you'll have to run `./node_modules/.bin/electron-rebuild` once to make sure `better-sqlite3` was compiled with Electron's toolchain.

demos/example-electron/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ Example demonstrating the use of the [PowerSync SDK for Web](/packages/web/READM
44

55
To see it in action:
66

7-
1. Make sure to run `pnpm install` and `pnpm build:packages` in the root directory of this repo.
7+
1. `cd` into this directory and run `pnpm install`.
88
2. Copy `.env.local.template` to `.env.local`, and complete the environment variables. You can generate a [temporary development token](https://docs.powersync.com/usage/installation/authentication-setup/development-tokens), or leave blank to test with local-only data.
9-
3. `cd` into this directory and run `pnpm start`.
9+
3. Run `pnpm start`.
1010

11-
The Electron app should open automatically.
11+
The Electron app should open automatically.

demos/example-nextjs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This example is built using [Next.js](https://nextjs.org/) and the [PowerSync JS
44

55
To see it in action:
66

7-
1. Make sure to run `pnpm install` and `pnpm build:packages` in the root directory of this repo.
7+
1. `cd` into this directory and run `pnpm install`.
88
2. Copy `.env.local.template` to `.env.local`, and complete the environment variables. You can generate a [temporary development token](https://docs.powersync.com/usage/installation/authentication-setup/development-tokens), or leave blank to test with local-only data.
9-
3. `cd` into this directory and run `pnpm start`.
9+
3. Run `pnpm start`.
1010
4. Open the localhost URL displayed in the terminal output in your browser.

demos/example-node/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ This demo is configured to talk to an example backend [you can host yourself](ht
66

77
1. Start one of the Node.js backend examples from [the self-host-demo repository](https://github.com/powersync-ja/self-host-demo).
88
2. If necessary, change `.env` to point to the started backend and sync service.
9-
3. Run `pnpm install` and `pnpm build:packages` in the root of this repo.
10-
4. In this directory, run `pnpm run start`.
9+
3. `cd` into this directory and run `pnpm install`.
10+
4. Run `pnpm start`.
1111

1212
This opens the local database, connects to PowerSync, waits for a first sync and then runs a simple query.
1313
Results from the query are printed every time it changes. Try:

demos/example-vite-encryption/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@ If the database does exist, it will use the encryption key to access the databas
66

77
To see it in action:
88

9-
1. Make sure to run `pnpm install` and `pnpm build:packages` in the root directory of this repo.
10-
2. `cd` into this directory, and run `pnpm start`.
9+
1. `cd` into this directory and run `pnpm install`.
10+
2. Run `pnpm start`.
1111
3. Open the localhost URL displayed in the terminal output in your browser.

demos/example-vite/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@ This is a minimal example demonstrating bundling with Vite. It attempts a connec
44

55
To see it in action:
66

7-
1. Make sure to run `pnpm install` and `pnpm build:packages` in the root directory of this repo.
8-
2. `cd` into this directory, and run `pnpm start`.
7+
1. `cd` into this directory and run `pnpm install`.
8+
2. Run `pnpm start`.
99
3. Open the localhost URL displayed in the terminal output in your browser.

demos/example-webpack/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@ This is a minimal example demonstrating bundling with Webpack. It attempts a con
44

55
To see it in action:
66

7-
1. Make sure to run `pnpm install` and `pnpm build:packages` in the root directory of this repo.
8-
2. `cd` into this directory, and run `pnpm start`.
7+
1. `cd` into this directory and run `pnpm install`.
8+
2. Run `pnpm start`.
99
3. Open the localhost URL displayed in the terminal output in your browser.

demos/react-multi-client/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,10 @@ Note that this setup guide has minor deviations from the [Supabase + PowerSync i
1414

1515
### 1. Install dependencies
1616

17-
In the repo directory, use [pnpm](https://pnpm.io/installation) to install dependencies:
17+
In the demo directory, use [pnpm](https://pnpm.io/installation) to install dependencies:
1818

1919
```bash
2020
pnpm install
21-
pnpm build:packages
2221
```
2322

2423
### 2. Create project on Supabase and set up Postgres

demos/react-native-barebones-opsqlite/README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,16 @@ This is a minimal example demonstrating a barebones React Native project using O
77

88
## Getting Started
99

10-
In the repo directory, use [pnpm](https://pnpm.io/installation) to install dependencies:
10+
Switch into the demo's directory:
1111

1212
```bash
13-
pnpm install
14-
pnpm build:packages
13+
cd demos/react-native-barebones-opsqlite
1514
```
1615

17-
Then switch into the demo's directory:
16+
Use [pnpm](https://pnpm.io/installation) to install dependencies:
1817

1918
```bash
20-
cd demos/react-native-barebones-opsqlite
19+
pnpm install
2120
```
2221

2322
Run the development server:

0 commit comments

Comments
 (0)