Skip to content

Commit 75fee42

Browse files
committed
improved README together with ChatGPT 4o
1 parent 1426d42 commit 75fee42

File tree

2 files changed

+67
-6
lines changed

2 files changed

+67
-6
lines changed

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,7 @@ dist-ssr
2222
*.njsproj
2323
*.sln
2424
*.sw?
25+
26+
# Rendered HTML
27+
README.html
28+
README_files

README.md

Lines changed: 63 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,66 @@
1-
# sql.js-httpvfs Playground
1+
# 🧪 CNAG-Biomedical-Informatics SQL.js-HTTPVFS Playground
22

3-
`sql.js-httpvfs` is a fork of and wrapper around sql.js to provide a read-only HTTP-Range-request based virtual file system for SQLite. It allows hosting an SQLite database on a static file hoster and querying that database from the browser without fully downloading it.
3+
[![GitHub Pages](https://img.shields.io/badge/GitHub-Pages-blue?logo=github)](https://cnag-biomedical-informatics.github.io/sql.js-httpvfs-playground)
4+
[![Deploy Status](https://github.com/CNAG-Biomedical-Informatics/sql.js-httpvfs-playground/actions/workflows/svelte.yml/badge.svg)](https://github.com/CNAG-Biomedical-Informatics/sql.js-httpvfs-playground/actions/workflows/svelte.yml)
45

5-
Provide the URL of any SQLite database file and edit the default SQL query.
6-
You can also use the query builder form to choose a column and value to quickly
7-
generate a filter.
86

9-
[Read more](https://github.com/phiresky/sql.js-httpvfs)
7+
This is a fork of [@nishad](https://github.com/nishad)’s [sql.js-httpvfs playground](https://github.com/nishad/sql.js-httpvfs-playground).
8+
9+
> 💡 It enables querying an SQLite database **stored on GitHub**, directly in the browser using GitHub Pages — powered by [`sql.js-httpvfs`](https://github.com/phiresky/sql.js-httpvfs), a wrapper around [sql.js](https://github.com/sql-js/sql.js).
10+
11+
---
12+
13+
## 🎯 Use Case
14+
15+
This tool lets you explore **Pheno-Ranker results** of:
16+
17+
- 🧬 [OMIM](https://omim.org)
18+
- 🧫 [TCGA](https://www.cancergenomeinterpreter.org/tcga)
19+
20+
from this live playground:
21+
22+
👉 [**cnag-biomedical-informatics.github.io/sql.js-httpvfs-playground**](https://cnag-biomedical-informatics.github.io/sql.js-httpvfs-playground)
23+
24+
The databases are served directly from:
25+
📁 [CNAG Biomedical Informatics - SQLite Folder](https://github.com/CNAG-Biomedical-Informatics/cbi-datahub/tree/main/sqlite)
26+
27+
---
28+
29+
## 🔄 Key Differences from nishad's Playground
30+
31+
Compared to the one by @nishad, this version includes:
32+
33+
### 🌟 More polished look and feel of the rendered [mounw-powertable](https://github.com/muonw/muonw-powertable/tree/main)
34+
35+
- [Power-table CSS](https://github.com/muonw/muonw-powertable/blob/main/app/src/lib/styles/power-table.scss) enabled
36+
- Clickable links in the table cells
37+
38+
### 🔗 Pre-configured Database URLs
39+
- No need to paste database links — switch between available datasets using **tabs**.
40+
41+
### 🧾 SQL Query Builder Form
42+
- No SQL skills? No problem! Easily build queries via a **form-based UI**.
43+
- ✍️ The [CodeJar](https://github.com/antonmedv/codejar) editor is **hidden by default** and can be toggled for manual editing.
44+
45+
---
46+
47+
# Authors
48+
49+
## 👤 Humans (at [CNAG](https://www.cnag.eu))
50+
- [Ivo Christopher Leist (ICL)](https://github.com/IvoLeist), PhD student
51+
- [Manuel Rueda (MR)](https://github.com/ManuelRueda), PhD
52+
53+
| Contributions | 👤 |
54+
| --- | --- |
55+
| Creation of this fork | ICL |
56+
| Adaptation of the original playground to the CNAG use case | ICL |
57+
| Running of Pheno-Ranker to generate SQLite databases | MR |
58+
59+
60+
## 🤖 GenAI tools contributions
61+
62+
| Tool | Contribution |
63+
| --- | --- |
64+
| GitHub Copilot | code completion |
65+
| OpenAI ChatGPT 4o and o4-mini-high | various code suggestions, styling of this README |
66+
| OpenAI Codex (research preview) | [merged PRs](https://github.com/CNAG-Biomedical-Informatics/sql.js-httpvfs-playground/pulls?q=is%3Apr+is%3Aclosed+label%3Acodex++is%3Amerged) |

0 commit comments

Comments
 (0)