datafolder 1.0.0 → 1.0.2

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.
Files changed (2) hide show
  1. package/README.md +13 -5
  2. package/package.json +36 -9
package/README.md CHANGED
@@ -1,10 +1,6 @@
1
1
  # datafolder
2
2
 
3
- datafolder is a highly efficient hierarchical virtual folder/file structured JSON database. It is implemented in pure native Node.js Javascript and has zero dependency, with full index and trigger features supported. The data can be organized into folders and sub folders, thus naturally partitioned. For example, airports, flights, orders can be stored as
4
-
5
- ```
6
- airports/{country}/{state}/{airport_id} flights/{from}/{to}/{flight_id} orders/{year}/{month}/{day}/{order_id}
7
- ```
3
+ datafolder is a lightweight JSON database, featuring an AI-friendly API for simple and human maintainable code generation, millisecond data response, with full index and trigger features supported, and the unique ability to browse and manage data as a folder tree directly in your browser. It works perfectly for a wide range of scenarios, from game/application backends to embedded systems to IoT to edge computing.
8
4
 
9
5
  ## Installation
10
6
 
@@ -46,6 +42,16 @@ dataFolder.insert(file, { score: score + 1, address: { city: "c", zipcode: 663 }
46
42
 
47
43
  ## Features
48
44
 
45
+ 🤖 AI-Friendly, Simple API: Designed for easy code generation by AI and long-term maintainability by humans.
46
+
47
+ ⚡ Extreme Data Access Speed: Supports fully in-memory operation for millisecond response, with configurable persistence to high-speed SSD.
48
+
49
+ 🌐 Built-in Browser Management: Visually browse and manage your data as a folder hierarchy directly within the browser, no separate tools needed.
50
+
51
+ 🧩 Plain JavaScript: Built with plain JavaScript, offers full TypeScript support and safe atomic writes.
52
+
53
+ 🔧 Designed for application/game backends, IoT, and edge computing scenarios, easily deployable on servers, in browsers, and even on embedded hardware.
54
+
49
55
  ### 1. Simple CRUD APIs
50
56
 
51
57
  #### Create
@@ -160,6 +166,8 @@ airbnb/{property_type}/{room_type}/{bed_type}/{_id}
160
166
 
161
167
  Once the data is inserted, it will open the browser at [datafolderui](http://localhost:3628/datafolderui/index.html) and the whole folder structures can be navigated.
162
168
 
169
+ <img width="2560" height="1438" alt="datafolder UI" src="https://github.com/user-attachments/assets/cf07fb86-5634-438e-b28e-424335088a68" />
170
+
163
171
  Next time to bring up the UI:
164
172
 
165
173
  ```bash
package/package.json CHANGED
@@ -1,16 +1,43 @@
1
1
  {
2
2
  "name": "datafolder",
3
- "version": "1.0.0",
4
- "author": "lysh <1wopjdzn1@mozmail.com>",
5
- "description": "datafolder is a highly efficient hierarchical virtual folder/file structured JSON database. It is implemented in pure native Node.js Javascript and has zero dependency, with full index and trigger features supported.",
3
+ "version": "1.0.2",
4
+ "author": {
5
+ "name": "lysh",
6
+ "email": "datafolderdev@outlook.com"
7
+ },
8
+ "description": "datafolder is a lightweight JSON database, featuring an AI-friendly API for simple and human maintainable code generation, millisecond data response, with full index and trigger features supported, and the unique ability to browse and manage data as a folder tree directly in your browser. It works perfectly for a wide range of scenarios, from game/application backends to embedded systems to IoT to edge computing.",
6
9
  "license": "MIT",
10
+ "repository": {
11
+ "type": "git",
12
+ "url": "git+https://github.com/datafolderdev/datafolder"
13
+ },
14
+ "homepage": "https://github.com/datafolderdev/datafolder",
15
+ "bugs": {
16
+ "url": "https://github.com/datafolderdev/datafolder/issues",
17
+ "email": "datafolderdev@outlook.com"
18
+ },
7
19
  "keywords": [
8
- "Hierarchical JSON Database",
9
- "virtual folder/file structured",
10
- "LSM Based Persistency",
11
- "Pure Javascript",
12
- "Zero Dependency",
13
- "Highly Efficient"
20
+ "JSON",
21
+ "database",
22
+ "AI",
23
+ "low-latency",
24
+ "tree-view",
25
+ "in-memory",
26
+ "SSD",
27
+ "schema-free",
28
+ "atomic-writes",
29
+ "typescript",
30
+ "edge",
31
+ "backend",
32
+ "gaming",
33
+ "iot",
34
+ "embed",
35
+ "embedded",
36
+ "simple",
37
+ "easy",
38
+ "quick",
39
+ "millisecond",
40
+ "lightweight"
14
41
  ],
15
42
  "dependencies": {},
16
43
  "devDependencies": {