mirror of
https://github.com/kunkunsh/kunkun.git
synced 2025-04-04 14:46:42 +00:00
ed87fc6c12
* chore: add vendor submodules * feat: add packages for db,ci,schema,api,jarvis cmds * feat: add tauri-jarvis-plugin * feat: implement extension commands list * fix(desktop): import path errors after packages refactor * chore: add self signed cert * fix: prevent prerender for desktop * fix(desktop): desktop sveltekit static build, use csr for dynamic route * feat: add error handling page and components * refactor: component lib * refactor: move more types, functions and components out of desktop * refactor(ui): more refactor * refactor(ui): move store components to @kksh/ui * ci: add CI for build & test * refactor: rename @kksh/extensions to @kksh/extension * ci: add 2 more ci * ci: fix * fix: CI env var * chore: add changeset * feat: implement extension store item detail view * feat: implement extension store install, uninstall, upgrade * format * revert: upgradable logic, the new one doesn't work yet * refactor: make @kksh/ui dependent only on @kksh/api Reason: @kksh/ui may be published later for building website, all its dependency packages must be also published. To avoid trouble it should be standalone, depend only on packages already published * refactor: cleanup * fixed: some typescript error * chore: got typedoc working on @kksh/api * ci: disable manifest schema upload CI on push
46 lines
1.1 KiB
Markdown
46 lines
1.1 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`
|
|
|
|
### Setup
|
|
|
|
```bash
|
|
git clone https://github.com/kunkunsh/kunkun.git --recursive
|
|
pnpm install
|
|
pnpm prepare
|
|
```
|
|
|
|
### Run Desktop App
|
|
|
|
```bash
|
|
pnpm --filter @kksh/desktop tauri dev
|
|
# or run it within the desktop app directory
|
|
cd apps/desktop
|
|
pnpm tauri dev
|
|
```
|