Skip to content

Commit 1dad8c8

Browse files
KKouldKKould
committed
feat: add KiteSQL website and refine wasm playground UI
1 parent 1192f52 commit 1dad8c8

8 files changed

Lines changed: 902 additions & 233 deletions

File tree

‎README.md‎

Lines changed: 36 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,48 @@
1-
# KiteSQL GitHub Profile Demo
1+
# KiteSQL Website
22

3-
A lightweight Vite site that showcases KiteSQL running fully in the browser via WebAssembly. Use it for GitHub Pages or any static host, then embed a link in your profile README.
3+
A small Vite site for KiteSQL that works as both:
44

5-
## Setup
5+
- a lightweight landing page for the project
6+
- an in-browser playground powered by the published WebAssembly build
7+
8+
The site lives next to the main repository so it can be deployed independently to GitHub Pages, Cloudflare Pages, Netlify, or any other static host.
9+
10+
## What it includes
11+
12+
- Product-style landing page for KiteSQL
13+
- Rust-native API / ORM / migration positioning
14+
- Interactive SQL playground backed by `WasmDatabase`
15+
- Zero-backend demo that runs fully in the browser
16+
17+
## Local development
18+
19+
Install dependencies:
620

7-
1) Install deps (pulls the published `kite_sql` npm package):
821
```bash
922
npm install
1023
```
11-
2) Run locally:
24+
25+
Start the dev server:
26+
1227
```bash
1328
npm run dev
1429
```
15-
> The app uses a small browser-friendly wrapper (`src/kite-sql-web.ts`) to load the npm-shipped `kite_sql_bg.wasm` with Vite’s `?url` asset handling. No local Rust build is needed.
1630

17-
## Scripts
18-
- `npm run dev` — start Vite dev server.
19-
- `npm run build` — produce static assets in `dist/` (ready for GitHub Pages).
20-
- `npm run preview` — preview the production build.
31+
Build the static site:
32+
33+
```bash
34+
npm run build
35+
```
36+
37+
Preview the production bundle:
38+
39+
```bash
40+
npm run preview
41+
```
42+
43+
## WebAssembly source
2144

22-
## Deploy to GitHub Pages
23-
- Push this folder as a separate repo or a `gh-pages` branch, then serve `dist/`.
24-
- In your GitHub profile README, link to the deployed page and add a badge/screenshot.
45+
The site currently uses the published npm package for KiteSQL wasm assets through `@kipdata/kite_sql`.
46+
That keeps the website simple to deploy because no local Rust build is required.
2547

26-
## How it works
27-
- Uses the published `kite_sql` wasm asset from npm with a small browser loader.
28-
- Runs a small SQL script (create/insert/update/select) entirely in the browser, then renders the result table.
48+
After publishing a newer npm package, bump the dependency version here if you want the website to track the latest release.

‎index.html‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,16 @@
33
<head>
44
<meta charset="UTF-8" />
55
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6-
<title>KiteSQL Wasm Demo</title>
6+
<title>KiteSQL | Embedded relational engine for Rust</title>
7+
<meta
8+
name="description"
9+
content="KiteSQL is an embedded relational engine for Rust with SQL, native APIs, ORM workflows, schema migration, and an in-browser WebAssembly playground."
10+
/>
711
<link rel="icon" href="/favicon.ico" />
812
<link rel="preconnect" href="https://fonts.googleapis.com" />
913
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
1014
<link
11-
href="https://fonts.googleapis.com/css2?family=Space+Grotesk:wght@400;500;600&display=swap"
15+
href="https://fonts.googleapis.com/css2?family=Space+Grotesk:wght@400;500;600;700&display=swap"
1216
rel="stylesheet"
1317
/>
1418
<link rel="stylesheet" href="/src/style.css" />

‎package-lock.json‎

Lines changed: 6 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "kitesql-github-profile",
2+
"name": "kitesql-website",
33
"version": "0.1.0",
44
"private": true,
55
"type": "module",
@@ -9,7 +9,7 @@
99
"preview": "vite preview"
1010
},
1111
"dependencies": {
12-
"@kipdata/kite_sql": "^0.1.4"
12+
"@kipdata/kite_sql": "^0.1.6"
1313
},
1414
"devDependencies": {
1515
"@types/node": "^22.9.0",

‎src/kite-sql-web.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@
77
import wasmUrl from "@kipdata/kite_sql/kite_sql_bg.wasm?url";
88

99
const placeholder: any = {};
10-
// The wasm expects its JS imports under the module name "./kite_sql_bg.js".
11-
const imports: any = { "./kite_sql_bg.js": placeholder };
10+
// The wasm expects its JS imports under the module name `__wbindgen_placeholder__`.
11+
const imports: any = { "__wbindgen_placeholder__": placeholder };
1212
let wasm: any;
1313

1414
function addToExternrefTable0(obj) {

0 commit comments

Comments
 (0)