Skip to content

Commit 4626e7f

Browse files
authored
Sync streams demo (#721)
1 parent 84a0af8 commit 4626e7f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+3183
-474
lines changed
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Copy this template: `cp .env.local.template .env.local`
2+
# Edit .env.local and enter your Supabase and PowerSync project details.
3+
VITE_SUPABASE_URL=https://foo.supabase.co
4+
VITE_SUPABASE_ANON_KEY=foo
5+
VITE_POWERSYNC_URL=https://foo.powersync.journeyapps.com
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
2+
3+
# dependencies
4+
/node_modules
5+
/.pnp
6+
.pnp.js
7+
.yarn/install-state.gz
8+
9+
# testing
10+
/coverage
11+
12+
# next.js
13+
/.next/
14+
/out/
15+
16+
# production
17+
/build
18+
# misc
19+
.DS_Store
20+
*.pem
21+
22+
# debug
23+
npm-debug.log*
24+
yarn-debug.log*
25+
yarn-error.log*
26+
27+
# local env files
28+
.env*.local
29+
30+
# vercel
31+
.vercel
32+
33+
# typescript
34+
*.tsbuildinfo
35+
next-env.d.ts
36+
37+
# ide
38+
.idea
39+
.fleet
40+
.vscode
41+
42+
# PWA
43+
**/public/workbox-*.js
44+
**/public/sw.js
45+
**/public/swe-worker-*
46+
**/public/worker-*.js
47+
**/public/fallback-*.js
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# react-supabase-todolist-sync-streams
Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
Creative Commons Legal Code
2+
3+
CC0 1.0 Universal
4+
5+
CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
6+
LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
7+
ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
8+
INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
9+
REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
10+
PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
11+
THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
12+
HEREUNDER.
13+
14+
Statement of Purpose
15+
16+
The laws of most jurisdictions throughout the world automatically confer
17+
exclusive Copyright and Related Rights (defined below) upon the creator
18+
and subsequent owner(s) (each and all, an "owner") of an original work of
19+
authorship and/or a database (each, a "Work").
20+
21+
Certain owners wish to permanently relinquish those rights to a Work for
22+
the purpose of contributing to a commons of creative, cultural and
23+
scientific works ("Commons") that the public can reliably and without fear
24+
of later claims of infringement build upon, modify, incorporate in other
25+
works, reuse and redistribute as freely as possible in any form whatsoever
26+
and for any purposes, including without limitation commercial purposes.
27+
These owners may contribute to the Commons to promote the ideal of a free
28+
culture and the further production of creative, cultural and scientific
29+
works, or to gain reputation or greater distribution for their Work in
30+
part through the use and efforts of others.
31+
32+
For these and/or other purposes and motivations, and without any
33+
expectation of additional consideration or compensation, the person
34+
associating CC0 with a Work (the "Affirmer"), to the extent that he or she
35+
is an owner of Copyright and Related Rights in the Work, voluntarily
36+
elects to apply CC0 to the Work and publicly distribute the Work under its
37+
terms, with knowledge of his or her Copyright and Related Rights in the
38+
Work and the meaning and intended legal effect of CC0 on those rights.
39+
40+
1. Copyright and Related Rights. A Work made available under CC0 may be
41+
protected by copyright and related or neighboring rights ("Copyright and
42+
Related Rights"). Copyright and Related Rights include, but are not
43+
limited to, the following:
44+
45+
i. the right to reproduce, adapt, distribute, perform, display,
46+
communicate, and translate a Work;
47+
ii. moral rights retained by the original author(s) and/or performer(s);
48+
iii. publicity and privacy rights pertaining to a person's image or
49+
likeness depicted in a Work;
50+
iv. rights protecting against unfair competition in regards to a Work,
51+
subject to the limitations in paragraph 4(a), below;
52+
v. rights protecting the extraction, dissemination, use and reuse of data
53+
in a Work;
54+
vi. database rights (such as those arising under Directive 96/9/EC of the
55+
European Parliament and of the Council of 11 March 1996 on the legal
56+
protection of databases, and under any national implementation
57+
thereof, including any amended or successor version of such
58+
directive); and
59+
vii. other similar, equivalent or corresponding rights throughout the
60+
world based on applicable law or treaty, and any national
61+
implementations thereof.
62+
63+
2. Waiver. To the greatest extent permitted by, but not in contravention
64+
of, applicable law, Affirmer hereby overtly, fully, permanently,
65+
irrevocably and unconditionally waives, abandons, and surrenders all of
66+
Affirmer's Copyright and Related Rights and associated claims and causes
67+
of action, whether now known or unknown (including existing as well as
68+
future claims and causes of action), in the Work (i) in all territories
69+
worldwide, (ii) for the maximum duration provided by applicable law or
70+
treaty (including future time extensions), (iii) in any current or future
71+
medium and for any number of copies, and (iv) for any purpose whatsoever,
72+
including without limitation commercial, advertising or promotional
73+
purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
74+
member of the public at large and to the detriment of Affirmer's heirs and
75+
successors, fully intending that such Waiver shall not be subject to
76+
revocation, rescission, cancellation, termination, or any other legal or
77+
equitable action to disrupt the quiet enjoyment of the Work by the public
78+
as contemplated by Affirmer's express Statement of Purpose.
79+
80+
3. Public License Fallback. Should any part of the Waiver for any reason
81+
be judged legally invalid or ineffective under applicable law, then the
82+
Waiver shall be preserved to the maximum extent permitted taking into
83+
account Affirmer's express Statement of Purpose. In addition, to the
84+
extent the Waiver is so judged Affirmer hereby grants to each affected
85+
person a royalty-free, non transferable, non sublicensable, non exclusive,
86+
irrevocable and unconditional license to exercise Affirmer's Copyright and
87+
Related Rights in the Work (i) in all territories worldwide, (ii) for the
88+
maximum duration provided by applicable law or treaty (including future
89+
time extensions), (iii) in any current or future medium and for any number
90+
of copies, and (iv) for any purpose whatsoever, including without
91+
limitation commercial, advertising or promotional purposes (the
92+
"License"). The License shall be deemed effective as of the date CC0 was
93+
applied by Affirmer to the Work. Should any part of the License for any
94+
reason be judged legally invalid or ineffective under applicable law, such
95+
partial invalidity or ineffectiveness shall not invalidate the remainder
96+
of the License, and in such case Affirmer hereby affirms that he or she
97+
will not (i) exercise any of his or her remaining Copyright and Related
98+
Rights in the Work or (ii) assert any associated claims and causes of
99+
action with respect to the Work, in either case contrary to Affirmer's
100+
express Statement of Purpose.
101+
102+
4. Limitations and Disclaimers.
103+
104+
a. No trademark or patent rights held by Affirmer are waived, abandoned,
105+
surrendered, licensed or otherwise affected by this document.
106+
b. Affirmer offers the Work as-is and makes no representations or
107+
warranties of any kind concerning the Work, express, implied,
108+
statutory or otherwise, including without limitation warranties of
109+
title, merchantability, fitness for a particular purpose, non
110+
infringement, or the absence of latent or other defects, accuracy, or
111+
the present or absence of errors, whether or not discoverable, all to
112+
the greatest extent permissible under applicable law.
113+
c. Affirmer disclaims responsibility for clearing rights of other persons
114+
that may apply to the Work or any use thereof, including without
115+
limitation any person's Copyright and Related Rights in the Work.
116+
Further, Affirmer disclaims responsibility for obtaining any necessary
117+
consents, permissions or other rights required for any use of the
118+
Work.
119+
d. Affirmer understands and acknowledges that Creative Commons is not a
120+
party to this document and has no duty or obligation with respect to
121+
this CC0 or use of the Work.
Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Sync streams demo
2+
3+
## Overview
4+
5+
This app is a fork of our [React Supabase Todolist Demo](../react-supabase-todolist/) to add support for sync streams.
6+
7+
Sync streams are not a stable PowerSync feature yet, and most users should probably use the stable demo instead.
8+
9+
To use this demo, deploy the following sync streams:
10+
11+
```yaml
12+
streams:
13+
lists:
14+
query: SELECT * FROM lists WHERE owner_id = auth.user_id()
15+
auto_subscribe: true
16+
todos:
17+
query: SELECT * FROM todos WHERE list_id = subscription.parameter('list') AND list_id IN (SELECT id FROM lists WHERE owner_id = auth.user_id())
18+
19+
config:
20+
edition: 2
21+
```
22+
23+
## Getting Started
24+
25+
In the repo directory, use [pnpm](https://pnpm.io/installation) to install dependencies:
26+
27+
```bash
28+
pnpm install
29+
pnpm build:packages
30+
```
31+
32+
Then switch into the demo's directory:
33+
34+
```bash
35+
cd demos/react-supabase-todolist-sync-streams
36+
```
37+
38+
Set up the Environment variables: Copy the `.env.local.template` file:
39+
40+
```bash
41+
cp .env.local.template .env.local
42+
```
43+
44+
And then edit `.env.local` to insert your credentials for Supabase.
45+
46+
Run the development server:
47+
48+
```bash
49+
pnpm dev
50+
```
51+
52+
Open [http://localhost:5173](http://localhost:5173) with your browser to see the result.
53+
54+
## Progressive Web App (PWA)
55+
56+
This demo is PWA compatible, and works fully offline. PWA is not available in development (watch) mode. The manifest and service worker is built using [vite-plugin-pwa](https://vite-pwa-org.netlify.app/).
57+
58+
Build the production codebase:
59+
60+
```bash
61+
pnpm build
62+
```
63+
64+
Run the production server:
65+
66+
```bash
67+
pnpm preview
68+
```
69+
70+
Open a browser on the served URL and install the PWA.
71+
72+
## Learn More
73+
74+
Check out [the PowerSync Web SDK on GitHub](https://github.com/powersync-ja/powersync-js/tree/main/packages/web) - your feedback and contributions are welcome!
75+
76+
To learn more about PowerSync, see the [PowerSync docs](https://docs.powersync.com).
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
{
2+
"name": "react-supabase-todolist",
3+
"version": "0.3.16",
4+
"private": true,
5+
"scripts": {
6+
"dev": "vite",
7+
"build": "tsc -b && vite build",
8+
"preview": "vite preview",
9+
"start": "pnpm build && pnpm preview"
10+
},
11+
"dependencies": {
12+
"@powersync/react": "workspace:*",
13+
"@powersync/web": "workspace:*",
14+
"@emotion/react": "11.11.4",
15+
"@emotion/styled": "11.11.5",
16+
"@journeyapps/wa-sqlite": "^1.3.1",
17+
"@mui/icons-material": "^5.15.12",
18+
"@mui/material": "^5.15.12",
19+
"@mui/x-data-grid": "^6.19.6",
20+
"@supabase/supabase-js": "^2.39.7",
21+
"formik": "^2.4.6",
22+
"lodash": "^4.17.21",
23+
"react": "^18.2.0",
24+
"react-dom": "^18.2.0",
25+
"react-router-dom": "^6.22.3"
26+
},
27+
"devDependencies": {
28+
"@swc/core": "~1.6.0",
29+
"@types/lodash": "^4.14.202",
30+
"@types/node": "^20.11.25",
31+
"@types/react": "^18.2.64",
32+
"@types/react-dom": "^18.2.21",
33+
"@vitejs/plugin-react": "^4.2.1",
34+
"autoprefixer": "^10.4.18",
35+
"babel-loader": "^9.1.3",
36+
"typescript": "^5.4.2",
37+
"vite": "^5.1.5",
38+
"vite-plugin-pwa": "^0.19.2",
39+
"vite-plugin-top-level-await": "^1.4.1",
40+
"vite-plugin-wasm": "^3.3.0"
41+
}
42+
}
1.54 KB
Binary file not shown.
26.5 KB
Loading
41.1 KB
Loading
72.8 KB
Loading

0 commit comments

Comments
 (0)