@chahuadev/framework 5.0.3 → 5.0.5
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 +28 -61
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,11 +1,25 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @chahuadev/framework
|
|
2
2
|
|
|
3
3
|
The official core executable framework for Chahuadev.
|
|
4
4
|
|
|
5
5
|
<p align="center">
|
|
6
|
-
<img src="https://
|
|
6
|
+
<img src="https://huggingface.co/datasets/chahuadev/chahuadev-framework-binaries/resolve/main/chahuadev-framework-binaries.png" width="600" alt="Chahuadev Framework">
|
|
7
7
|
</p>
|
|
8
8
|
|
|
9
|
+
<p align="center">
|
|
10
|
+
<a href="https://www.npmjs.com/package/@chahuadev/framework"><img src="https://img.shields.io/npm/v/@chahuadev/framework?style=for-the-badge&color=blue" alt="NPM Version"></a>
|
|
11
|
+
<a href="https://www.npmjs.com/package/@chahuadev/framework"><img src="https://img.shields.io/npm/dt/@chahuadev/framework?style=for-the-badge&color=success" alt="NPM Downloads"></a>
|
|
12
|
+
</p>
|
|
13
|
+
|
|
14
|
+
This package provides a seamless way to integrate and run the Chahuadev Framework directly from your Node.js environment or Command Line Interface (CLI).
|
|
15
|
+
|
|
16
|
+
> **Development Journey:** This framework is the proud result of **1 full year of dedicated development**. What began as a simple concept evolved into a highly advanced, secure, and robust architecture. Every line of code was meticulously crafted to ensure maximum stability and a premium experience for developers.
|
|
17
|
+
|
|
18
|
+
> **Multi-Platform Support:** This framework runs on **Windows (x64, ia32)** and **Linux (x64)**.
|
|
19
|
+
> Our system automatically detects your operating system and securely downloads the required binary behind the scenes.
|
|
20
|
+
|
|
21
|
+
---
|
|
22
|
+
|
|
9
23
|
This package provides a seamless way to integrate and run the Chahuadev Framework directly from your Node.js environment or Command Line Interface (CLI).
|
|
10
24
|
|
|
11
25
|
> **Multi-Platform Support:** This framework runs on **Windows (x64, ia32)** and **Linux (x64)**.
|
|
@@ -19,7 +33,7 @@ This package provides a seamless way to integrate and run the Chahuadev Framewor
|
|
|
19
33
|
If you want to use the framework from your terminal anywhere on your system:
|
|
20
34
|
|
|
21
35
|
```bash
|
|
22
|
-
npm install -g @chahuadev/framework
|
|
36
|
+
npm install -g @chahuadev/framework --foreground-scripts --force
|
|
23
37
|
```
|
|
24
38
|
|
|
25
39
|
After installation, simply launch it:
|
|
@@ -36,54 +50,11 @@ The framework will:
|
|
|
36
50
|
If you want to integrate the framework into your specific project:
|
|
37
51
|
|
|
38
52
|
```bash
|
|
39
|
-
npm install @chahuadev/framework
|
|
53
|
+
npm install -g @chahuadev/framework --foreground-scripts --force
|
|
40
54
|
```
|
|
41
55
|
|
|
42
56
|
---
|
|
43
57
|
|
|
44
|
-
## Usage
|
|
45
|
-
|
|
46
|
-
### 1. Command Line Interface (CLI)
|
|
47
|
-
If installed globally:
|
|
48
|
-
|
|
49
|
-
```bash
|
|
50
|
-
# Simple launch
|
|
51
|
-
chahuadev-framework
|
|
52
|
-
|
|
53
|
-
# With arguments
|
|
54
|
-
chahuadev-framework --dev-mode
|
|
55
|
-
chahuadev-framework --help
|
|
56
|
-
```
|
|
57
|
-
|
|
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
|
-
|
|
72
|
-
---
|
|
73
|
-
|
|
74
|
-
## How It Works
|
|
75
|
-
|
|
76
|
-
This package uses **`optionalDependencies`** to handle platform-specific binaries:
|
|
77
|
-
|
|
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
58
|
|
|
88
59
|
**When you install:**
|
|
89
60
|
1. npm detects your OS and architecture
|
|
@@ -101,8 +72,8 @@ This ensures:
|
|
|
101
72
|
|
|
102
73
|
| Platform | Architecture | Status | Format |
|
|
103
74
|
|----------|-------------|--------|--------|
|
|
104
|
-
| Windows | 64-bit (x64) | Supported | EXE
|
|
105
|
-
| Windows | 32-bit (ia32) | Supported | EXE
|
|
75
|
+
| Windows | 64-bit (x64) | Supported | EXE |
|
|
76
|
+
| Windows | 32-bit (ia32) | Supported | EXE |
|
|
106
77
|
| Linux | 64-bit (x64) | Supported | AppImage |
|
|
107
78
|
| macOS | Intel (x64) | Coming Soon | DMG/App |
|
|
108
79
|
| macOS | Apple Silicon (arm64) | Coming Soon | DMG/App |
|
|
@@ -113,14 +84,12 @@ This ensures:
|
|
|
113
84
|
|
|
114
85
|
```
|
|
115
86
|
@chahuadev/
|
|
116
|
-
├── framework/
|
|
117
|
-
│ └── index.js
|
|
118
|
-
|
|
119
|
-
│ └──
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
└── framework-linux-x64/
|
|
123
|
-
└── bin/ (Linux x64 AppImage)
|
|
87
|
+
├── framework/
|
|
88
|
+
│ └── index.js
|
|
89
|
+
│ └── install.js
|
|
90
|
+
│ └── package.json
|
|
91
|
+
│ └── README.md
|
|
92
|
+
|
|
124
93
|
```
|
|
125
94
|
|
|
126
95
|
---
|
|
@@ -130,13 +99,13 @@ This ensures:
|
|
|
130
99
|
### "Command not found: chahuadev-framework"
|
|
131
100
|
Make sure you installed globally:
|
|
132
101
|
```bash
|
|
133
|
-
npm install -g @chahuadev/framework
|
|
102
|
+
npm install -g @chahuadev/framework --foreground-scripts --force
|
|
134
103
|
```
|
|
135
104
|
|
|
136
105
|
### "Module not found"
|
|
137
106
|
If using locally, ensure it's installed:
|
|
138
107
|
```bash
|
|
139
|
-
npm install @chahuadev/framework
|
|
108
|
+
npm install -g @chahuadev/framework --foreground-scripts --force
|
|
140
109
|
```
|
|
141
110
|
|
|
142
111
|
### "Unsupported platform"
|
|
@@ -149,7 +118,5 @@ Proprietary - Chahua Development Thailand
|
|
|
149
118
|
|
|
150
119
|
---
|
|
151
120
|
|
|
152
|
-
## Support
|
|
153
|
-
For issues or questions, visit: https://github.com/chahuadev/chahuadev-framework
|
|
154
121
|
|
|
155
122
|
|