@dataramen/cli 0.0.82 → 0.0.83
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
CHANGED
|
@@ -1,35 +1,26 @@
|
|
|
1
|
-
#
|
|
1
|
+
# DataRamen
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
A lightweight web GUI for MySQL and PostgreSQL, built for developers who move fast and stay focused. Connect, explore, and inspect your data effortlessly, no boilerplate, no friction. Visit [dataramen.xyz](https://dataramen.xyz) for more info.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
## Why use it?
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
- **Follow relationships easily**
|
|
8
|
+
DataRamen allows you to easily navigate between related records and tables.
|
|
8
9
|
|
|
9
|
-
-
|
|
10
|
-
|
|
10
|
+
- **No-SQL querying**
|
|
11
|
+
Filter, sort, join, and summarize data using intuitive interface.
|
|
11
12
|
|
|
12
|
-
-
|
|
13
|
-
|
|
13
|
+
- **Insert & update visually**
|
|
14
|
+
Add or modify records with a visual editor.
|
|
14
15
|
|
|
15
|
-
-
|
|
16
|
-
|
|
16
|
+
- **Connect to PostgreSQL & MySQL**
|
|
17
|
+
Plug in your credentials - you're ready to explore.
|
|
17
18
|
|
|
18
|
-
|
|
19
|
-
Click to expand related records.
|
|
20
|
-
|
|
21
|
-
- ✏️ **Insert & Update Visually**
|
|
22
|
-
Add or modify rows with a visual editor - no SQL errors.
|
|
23
|
-
|
|
24
|
-
- 💾 **Save Queries**
|
|
25
|
-
Save your favorite views for quick access later.
|
|
26
|
-
|
|
27
|
-
## 🛠️ Installation
|
|
19
|
+
## Installation
|
|
28
20
|
|
|
29
21
|
### 1. Install Node.js
|
|
30
22
|
|
|
31
|
-
DataRamen requires Node.js **v22 or above
|
|
32
|
-
👉 [Download Node.js](https://nodejs.org/)
|
|
23
|
+
DataRamen requires Node.js **v22 or above**: [Download Node.js](https://nodejs.org/)
|
|
33
24
|
|
|
34
25
|
### 2. Install DataRamen CLI
|
|
35
26
|
|
|
@@ -39,7 +30,7 @@ Open your terminal and run:
|
|
|
39
30
|
npm i -g @dataramen/cli
|
|
40
31
|
```
|
|
41
32
|
|
|
42
|
-
##
|
|
33
|
+
## Usage
|
|
43
34
|
|
|
44
35
|
### Start the Local Server
|
|
45
36
|
|
|
@@ -49,7 +40,7 @@ dataramen start
|
|
|
49
40
|
|
|
50
41
|
### Open the App
|
|
51
42
|
|
|
52
|
-
|
|
43
|
+
Open your app in the browser. By default, the app runs on `localhost:4466`.
|
|
53
44
|
|
|
54
45
|
### Update the App
|
|
55
46
|
|
|
@@ -61,7 +52,7 @@ npm i -g @dataramen/cli
|
|
|
61
52
|
|
|
62
53
|
The above command will install latest stable version.
|
|
63
54
|
|
|
64
|
-
##
|
|
55
|
+
## Additional CLI Commands
|
|
65
56
|
|
|
66
57
|
| Command | Description |
|
|
67
58
|
|-------------------|----------------------------------|
|
|
@@ -70,6 +61,7 @@ The above command will install latest stable version.
|
|
|
70
61
|
| `dataramen open` | Open local webapp |
|
|
71
62
|
| `dataramen logs` | Show logs from the running server|
|
|
72
63
|
|
|
73
|
-
|
|
64
|
+
|
|
65
|
+
## Other
|
|
74
66
|
|
|
75
67
|
Visit [dataramen.xyz](https://dataramen.xyz) for more info.
|