kunkun/CONTRIBUTING.md
Huakun Shen b115e0a574
Feature: i18n (#70)
* chore: add @inlang/paraglide-sveltekit to @kksh/ui

* feat: add i18n to desktop

* fix: add shrink-0 class to mode-toggle button for consistent styling

* feat: add i18n to settings, not working yet

* feat: i18 working

* feat: add i18n for about

* feat: migrate all goto to use i18n.resolveRoute

* feat: finish translating settings to chinese

* feat: add Chinese i18n for troubleshooters

* feat: add russian translation (by AI)

* format: run prettier

* format

* chore: update .prettierignore to exclude src/lib/paraglide/**
2025-01-19 23:22:15 -05:00

51 lines
1.3 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
```
## 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.