https://github.com/wisdomgardeninc/cloak
Cloak - A Hybrid Development Framework for HarmonyOS
https://github.com/wisdomgardeninc/cloak
capacitor capacitor-plugin cordova cordova-plugin h5 harmonyos harmonyos-next hybrid hybrid-app jsbridge webview
Last synced: 2 months ago
JSON representation
Cloak - A Hybrid Development Framework for HarmonyOS
- Host: GitHub
- URL: https://github.com/wisdomgardeninc/cloak
- Owner: WisdomGardenInc
- License: other
- Created: 2025-02-25T08:07:06.000Z (2 months ago)
- Default Branch: master
- Last Pushed: 2025-02-25T10:22:35.000Z (2 months ago)
- Last Synced: 2025-02-25T10:36:05.724Z (2 months ago)
- Topics: capacitor, capacitor-plugin, cordova, cordova-plugin, h5, harmonyos, harmonyos-next, hybrid, hybrid-app, jsbridge, webview
- Language: JavaScript
- Homepage:
- Size: 231 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README-EN.md
- License: LICENSE
Awesome Lists containing this project
README
[**δΈζη**](./README.md) | [English Version](./README-EN.md)
# **Cloak** - Hybrid Development Framework for HarmonyOS
**Cloak** is a lightweight hybrid development framework for **HarmonyOS**, inspired by [Cordova](https://cordova.apache.org/) and [Capacitor](https://capacitorjs.com/), but with **simpler implementation** and **better performance**.
Enables rapid conversion of web applications to native HarmonyOS apps with plugin-based native API access.
---
## Core Features
- **Quick Packaging**
Compile H5/web apps into HarmonyOS applications within minutes
- **Native API Access**
Extend functionality through HarmonyOS native plugins
- **Optimized WebView**
High-performance WebView container with hardware acceleration
- **Plugin Development**
Easily create HarmonyOS native plugins using TypeScript/ArkTS
---
## Important Notes
- **No Compatibility** with existing Cordova/Capacitor plugins
All plugins must be **redeveloped** using HarmonyOS native APIs
### Existing Plugins
- **[CloakPluginPermission](./plugins/CloakPluginPermission/README.md)** `ohpm i @wisdomgarden/cloak-plugin-permission`
Used to check and request HarmonyOS permissions.
---
## Getting Started
### Run Demo App
1. **Create EmptyAbility Project**
Follow official guide: [Building the First ArkTS Application in Stage Model](https://developer.huawei.com/consumer/en/doc/harmonyos-guides-V5/start-with-ets-stage-V5)
2. **Install Cloak Framework**
```bash
ohpm install @wisdomgarden/cloak
```
The built-in demo will be automatically available.
---
### Integrate Your Web App
3. **Create Config File**
Add `entry/src/main/resources/rawfile/config.json`:
```json
{
"APP_FOLDER": "www",
"APP_HOST": "http://localhost",
"APP_IDENTITY_USER_AGENT": "YourAppName/HarmonyOS",
"IS_DEBUG": false,
"WEB_VIEW_USE_APP_PERMISSION": true
}
```
4. **Deploy Web Assets**
Copy your web app (must contain **index.html**) to `entry/src/main/resources/rawfile/www`
5. **Debug & Run**
Use DevEco Studio for real-time debugging
6. **Plugin Development**
Develop custom plugins or find community plugins via [OHPM registry](https://ohpm.openharmony.cn)
## Example
Complete the [Getting Started](#getting-started) steps, and refer to: https://github.com/WisdomGardenInc/Cloak for more details.