mirror of
https://github.com/kunkunsh/kunkun.git
synced 2025-04-03 22:26:43 +00:00
a92c266d32
* upgrade tauri-plugin-shellx * feat(shell): add killPid method to shell API with new permission * fix: extension new window * feat(shell): enhance process management and logging in extensions - Add debug logging for extension process events - Implement process tracking in UI worker - Update shell API to support custom process recording - Modify extension template to demonstrate process spawning - Refactor shell command handling with improved error handling * Add killPid extension API to @kksh/api * chore(deps): update tauri-plugin-shellx-api to version 2.0.15 * pnpm lock * chore(deps): update dependencies and lock file - Upgrade ESLint to version 9.21.0 - Update @types/bun to version 1.2.3 - Bump various development dependencies - Reorganize package.json dependencies in ui package * chore(deps): update SvelteKit template dependencies - Add @eslint/js version 9.21.0 - Update package.json dependency order - Sync pnpm-lock.yaml with package.json changes * chore: add eslint to desktop * chore(deps): remove local tauri-plugin-shellx and use published version 2.0.15 * bump desktop to 0.1.28
62 lines
1.6 KiB
Markdown
62 lines
1.6 KiB
Markdown
# Contributing
|
|
|
|
If you are interested in contributing to the project, please read the following guidelines.
|
|
|
|
## Development
|
|
|
|
### Prerequisites
|
|
|
|
- [Node.js](https://nodejs.org/en)
|
|
- [pnpm](https://pnpm.io/)
|
|
- [Bun](https://bun.sh/)
|
|
- [Deno](https://deno.com/)
|
|
- [Rust](https://www.rust-lang.org/)
|
|
- [protobuf](https://grpc.io/docs/protoc-installation/)
|
|
- MacOS: `brew install protobuf`
|
|
- Linux: `sudo apt install -y protobuf-compiler`
|
|
- Windows:
|
|
```powershell
|
|
choco install protoc
|
|
choco install openssl
|
|
```
|
|
Then configure the environment variables (yours may differ):
|
|
- `OPENSSL_DIR`: `C:\Program Files\OpenSSL-Win64`
|
|
- `OPENSSL_INCLUDE_DIR`: `C:\Program Files\OpenSSL-Win64\include`
|
|
- `OPENSSL_LIB_DIR`: `C:\Program Files\OpenSSL-Win64\lib`
|
|
- [cmake](https://cmake.org/)
|
|
- MacOS: `brew install cmake`
|
|
- Linux: `sudo apt install -y cmake`
|
|
- Other Linux Dependencies
|
|
- `sudo apt-get install -y protobuf-compiler libwebkit2gtk-4.1-dev libappindicator3-dev librsvg2-dev patchelf libxdo-dev`
|
|
|
|
### Setup
|
|
|
|
```bash
|
|
git clone https://github.com/kunkunsh/kunkun.git --recursive
|
|
pnpm install
|
|
pnpm build # build submodules
|
|
```
|
|
|
|
### Run Desktop App
|
|
|
|
```bash
|
|
pnpm --filter @kksh/desktop tauri dev
|
|
# or run it within the desktop app directory
|
|
cd apps/desktop
|
|
pnpm tauri dev
|
|
```
|
|
|
|
### Build from Source
|
|
|
|
If you have problem running the app, consider building from source to see if it works.
|
|
|
|
```bash
|
|
cd apps/desktop
|
|
pnpm tauri build
|
|
```
|
|
|
|
## i188n
|
|
|
|
If you are willing to help with the translation, please use translations in json files in `apps/desktop/messages`.
|
|
Use `en.json` as a reference.
|