Skip to content

Commit 073b28a

Browse files
committed
Node: Add readme
1 parent 6c4b958 commit 073b28a

File tree

1 file changed

+39
-1
lines changed

1 file changed

+39
-1
lines changed

packages/node/README.md

Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,39 @@
1-
TODO
1+
<p align="center">
2+
<a href="https://www.powersync.com" target="_blank"><img src="https://github.com/powersync-ja/.github/assets/7372448/d2538c43-c1a0-4c47-9a76-41462dba484f"/></a>
3+
</p>
4+
5+
# PowerSync SDK for Node.JS
6+
7+
_[PowerSync](https://www.powersync.com) is a sync engine for building local-first apps with instantly-responsive UI/UX and simplified state transfer. Syncs between SQLite on the client-side and Postgres, MongoDB or MySQL on the server-side._
8+
9+
This package (`packages/node`) is the PowerSync SDK for NodeJS clients. It is an extension of `packages/common`.
10+
Using this package is not necessary for PowerSync on servers, see [our documentation](https://docs.powersync.com/installation/app-backend-setup) for more details on that.
11+
12+
This package has an API similar to the PowerSync web SDK, for which a summary of features is available [here](https://docs.powersync.com/client-sdk-references/js-web).
13+
14+
# Installation
15+
16+
## Install Package
17+
18+
```bash
19+
npm install @powersync/node
20+
```
21+
22+
Both `@powersync/node` and the `better-sqlite3` packages have install scripts that need to run to compile
23+
or download sqlite3 and PowerSync binaries.
24+
25+
# Getting Started
26+
27+
You can follow along our [web SDK reference](https://docs.powersync.com/client-sdk-references/js-web) for the web
28+
which contains everything you need to know to get started implementing PowerSync in your project.
29+
Replace imports of `@powersync/web` with `@powersync/node` where necessary.
30+
31+
# Examples
32+
33+
A simple example using `@powersync/node` is available in the [`demos/example-node/`](../demos/example-node) directory.
34+
35+
# Found a bug or need help?
36+
37+
- Join our [Discord server](https://discord.gg/powersync) where you can browse topics from our community, ask questions, share feedback, or just say hello :)
38+
- Please open a [GitHub issue](https://github.com/powersync-ja/powersync-js/issues) when you come across a bug.
39+
- Have feedback or an idea? [Submit an idea](https://roadmap.powersync.com/tabs/5-roadmap/submit-idea) via our public roadmap or [schedule a chat](https://calendly.com/powersync-product/powersync-chat) with someone from our product team.

0 commit comments

Comments
 (0)