Skip to content

Latest commit

 

History

History
45 lines (37 loc) · 1.11 KB

CONTRIBUTING.md

File metadata and controls

45 lines (37 loc) · 1.11 KB

Contributing

If you are interested in contributing to the project, please read the following guidelines.

Development

Prerequisites

  • Node.js
  • pnpm
  • Bun
  • Deno
  • Rust
  • protobuf
    • MacOS: brew install protobuf
    • Linux: sudo apt install -y protobuf-compiler
    • Windows:
      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
    • MacOS: brew install cmake
    • Linux: sudo apt install -y cmake

Setup

git clone https://github.com/kunkunsh/kunkun.git --recursive
pnpm install
pnpm prepare

Run Desktop App

pnpm --filter @kksh/desktop tauri dev
# or run it within the desktop app directory
cd apps/desktop
pnpm tauri dev