nicefox-graphdb 1.0.3 → 1.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +19 -0
- package/package.json +4 -2
package/README.md
CHANGED
|
@@ -11,6 +11,25 @@ A lightweight graph database with Cypher query support, powered by SQLite.
|
|
|
11
11
|
npm install nicefox-graphdb
|
|
12
12
|
```
|
|
13
13
|
|
|
14
|
+
### Native Dependencies
|
|
15
|
+
|
|
16
|
+
The `better-sqlite3` native module is an **optional dependency**:
|
|
17
|
+
|
|
18
|
+
- **Production mode** (remote HTTP client): No native dependencies, no compilation required
|
|
19
|
+
- **Development mode** (local SQLite): Requires `better-sqlite3`
|
|
20
|
+
|
|
21
|
+
If you only connect to a remote GraphDB server, you can skip native compilation entirely:
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
npm install nicefox-graphdb --ignore-optional
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
For local/embedded mode, ensure `better-sqlite3` is installed:
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
npm install nicefox-graphdb better-sqlite3
|
|
31
|
+
```
|
|
32
|
+
|
|
14
33
|
## Quick Start
|
|
15
34
|
|
|
16
35
|
```typescript
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "nicefox-graphdb",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.4",
|
|
4
4
|
"description": "SQLite-based graph database with Cypher query support",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "packages/nicefox-graphdb/dist/index.js",
|
|
@@ -32,10 +32,12 @@
|
|
|
32
32
|
},
|
|
33
33
|
"dependencies": {
|
|
34
34
|
"@hono/node-server": "^1.13.0",
|
|
35
|
-
"better-sqlite3": "^11.0.0",
|
|
36
35
|
"commander": "^12.0.0",
|
|
37
36
|
"hono": "^4.0.0"
|
|
38
37
|
},
|
|
38
|
+
"optionalDependencies": {
|
|
39
|
+
"better-sqlite3": "^11.0.0"
|
|
40
|
+
},
|
|
39
41
|
"devDependencies": {
|
|
40
42
|
"@types/better-sqlite3": "^7.6.0",
|
|
41
43
|
"@types/node": "^22.0.0",
|