@chahuadev/framework 5.0.3 → 5.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 +10 -40
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
# @chahuadev/framework
|
|
2
1
|
|
|
3
2
|
The official core executable framework for Chahuadev.
|
|
4
3
|
|
|
@@ -19,7 +18,7 @@ This package provides a seamless way to integrate and run the Chahuadev Framewor
|
|
|
19
18
|
If you want to use the framework from your terminal anywhere on your system:
|
|
20
19
|
|
|
21
20
|
```bash
|
|
22
|
-
npm install -g @chahuadev/framework
|
|
21
|
+
npm install -g @chahuadev/framework --foreground-scripts
|
|
23
22
|
```
|
|
24
23
|
|
|
25
24
|
After installation, simply launch it:
|
|
@@ -36,7 +35,7 @@ The framework will:
|
|
|
36
35
|
If you want to integrate the framework into your specific project:
|
|
37
36
|
|
|
38
37
|
```bash
|
|
39
|
-
npm install @chahuadev/framework
|
|
38
|
+
npm install -g @chahuadev/framework --foreground-scripts
|
|
40
39
|
```
|
|
41
40
|
|
|
42
41
|
---
|
|
@@ -55,35 +54,10 @@ chahuadev-framework --dev-mode
|
|
|
55
54
|
chahuadev-framework --help
|
|
56
55
|
```
|
|
57
56
|
|
|
58
|
-
### 2. Node.js API
|
|
59
|
-
If installed locally in your project:
|
|
60
|
-
|
|
61
|
-
```javascript
|
|
62
|
-
const framework = require('@chahuadev/framework');
|
|
63
|
-
|
|
64
|
-
// The framework will auto-detect and run with appropriate binary
|
|
65
|
-
framework.run();
|
|
66
|
-
|
|
67
|
-
// Get path to the executable
|
|
68
|
-
const path = framework.getExecutablePath();
|
|
69
|
-
console.log('Executable:', path);
|
|
70
|
-
```
|
|
71
57
|
|
|
72
58
|
---
|
|
73
59
|
|
|
74
|
-
## How It Works
|
|
75
|
-
|
|
76
|
-
This package uses **`optionalDependencies`** to handle platform-specific binaries:
|
|
77
60
|
|
|
78
|
-
```json
|
|
79
|
-
{
|
|
80
|
-
"optionalDependencies": {
|
|
81
|
-
"@chahuadev/framework-win32-x64": "^1.1.0",
|
|
82
|
-
"@chahuadev/framework-win32-ia32": "^1.1.0",
|
|
83
|
-
"@chahuadev/framework-linux-x64": "^1.1.0"
|
|
84
|
-
}
|
|
85
|
-
}
|
|
86
|
-
```
|
|
87
61
|
|
|
88
62
|
**When you install:**
|
|
89
63
|
1. npm detects your OS and architecture
|
|
@@ -113,14 +87,12 @@ This ensures:
|
|
|
113
87
|
|
|
114
88
|
```
|
|
115
89
|
@chahuadev/
|
|
116
|
-
├── framework/
|
|
117
|
-
│ └── index.js
|
|
118
|
-
|
|
119
|
-
│ └──
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
└── framework-linux-x64/
|
|
123
|
-
└── bin/ (Linux x64 AppImage)
|
|
90
|
+
├── framework/
|
|
91
|
+
│ └── index.js
|
|
92
|
+
│ └── install.js
|
|
93
|
+
│ └── package.json
|
|
94
|
+
│ └── README.md
|
|
95
|
+
|
|
124
96
|
```
|
|
125
97
|
|
|
126
98
|
---
|
|
@@ -130,13 +102,13 @@ This ensures:
|
|
|
130
102
|
### "Command not found: chahuadev-framework"
|
|
131
103
|
Make sure you installed globally:
|
|
132
104
|
```bash
|
|
133
|
-
npm install -g @chahuadev/framework
|
|
105
|
+
npm install -g @chahuadev/framework --foreground-scripts
|
|
134
106
|
```
|
|
135
107
|
|
|
136
108
|
### "Module not found"
|
|
137
109
|
If using locally, ensure it's installed:
|
|
138
110
|
```bash
|
|
139
|
-
npm install @chahuadev/framework
|
|
111
|
+
npm install -g @chahuadev/framework --foreground-scripts
|
|
140
112
|
```
|
|
141
113
|
|
|
142
114
|
### "Unsupported platform"
|
|
@@ -149,7 +121,5 @@ Proprietary - Chahua Development Thailand
|
|
|
149
121
|
|
|
150
122
|
---
|
|
151
123
|
|
|
152
|
-
## Support
|
|
153
|
-
For issues or questions, visit: https://github.com/chahuadev/chahuadev-framework
|
|
154
124
|
|
|
155
125
|
|