philipgreat commited on
Commit
373f928
·
verified ·
1 Parent(s): 3f69d52

Document browser-only TeaQL SQLite playground

Browse files
Files changed (1) hide show
  1. README.md +25 -4
README.md CHANGED
@@ -1,10 +1,31 @@
1
  ---
2
- title: Browser Sqlite Playground
3
- emoji: 🚀
4
- colorFrom: red
5
  colorTo: blue
6
  sdk: static
 
7
  pinned: false
 
 
8
  ---
9
 
10
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ title: TeaQL Browser SQLite Playground
3
+ emoji: 🫖
4
+ colorFrom: green
5
  colorTo: blue
6
  sdk: static
7
+ app_file: dist/index.html
8
  pinned: false
9
+ license: apache-2.0
10
+ short_description: TeaQL and SQLite, entirely in your browser.
11
  ---
12
 
13
+ # TeaQL Browser SQLite Playground
14
+
15
+ This playground runs entirely inside your browser:
16
+
17
+ - SQLite runs as WebAssembly in a dedicated Web Worker.
18
+ - Generated TeaQL Q APIs execute against that browser-local database.
19
+ - Demo records are created through audited generated mutation APIs.
20
+ - Memory mode resets on refresh and gives every visitor the same starting point.
21
+ - Optional OPFS mode persists data within the current browser origin when the host supports it.
22
+ - Reset drops the local schema, recreates it, and seeds the demo again.
23
+
24
+ There is no application backend and no server-side business database. The
25
+ Space only serves static HTML, JavaScript, CSS, and WASM assets. Query and
26
+ mutation data remain in the visitor's browser.
27
+
28
+ The complete source and executable browser smoke test are maintained in the
29
+ [`teaql-ts` browser-sqlite example](https://github.com/teaql/teaql-ts/tree/main/examples/browser-sqlite).
30
+
31
+ Learn more at [teaql.io](https://teaql.io/).