Skip to content

Node.js examples Readme polishes #543

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 26, 2025
Merged

Node.js examples Readme polishes #543

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Demo applications are located in the [`demos/`](./demos/) directory. Also see ou
### Electron

- [demos/example-electron](./demos/example-electron/README.md) An Electron example web rendered app using the PowerSync Web SDK in the renderer process.
- [demos/example-electron-node](./demos/example-electron-node/README.md) An Electron example using a PowerSync database in the main process.
- [demos/example-electron-node](./demos/example-electron-node/README.md) An Electron example that runs PowerSync in the main process using the PowerSync Node.js SDK.

### Capacitor

Expand Down
2 changes: 1 addition & 1 deletion demos/example-electron-node/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# PowerSync + Electron in main process

This example shows how the [PowerSync Node.js client](https://docs.powersync.com/client-sdk-references/node) can be used in the main process of an Electron app.
This example shows how the [PowerSync Node.js client SDK](https://docs.powersync.com/client-sdk-references/node) can be used in the main process of an Electron app.

The purpose of this example is to highlight specific build configurations that enable this setup.
In particular:
Expand Down
8 changes: 6 additions & 2 deletions demos/example-node/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Node.js Demo
## Node.js CLI Demo

This demonstrates a small Node.js client opening a database and connecting PowerSync.
This demonstrates a small Node.js CLI client opening a database, connecting PowerSync and running live queries.

This demo is configured to talk to an example backend [you can host yourself](https://github.com/powersync-ja/self-host-demo). To get started:

Expand All @@ -14,3 +14,7 @@ Results from the query are printed every time it changes. Try:

1. Updating a row in the backend database and see changes reflected in the running client.
2. Enter `add('my list')` and see the new list show up in the backend database.

For more details, see the documentation for [the PowerSync node package](https://docs.powersync.com/client-sdk-references/node) and check other examples:

- [example-electron-node](../example-electron-node/): An Electron example that runs PowerSync in the main process using the Node.js SDK.