📥 Download

📋 Table of Contents

• 📥 Download
• 📖 Documentation
• 🗂 Project Structure
• 🚀 Getting Onboard
• 🧑‍💻 Development
• 🏡 Community & Enterprise Edition
• 💡 Support
• 🔰 Security
• 💬 Docs in Your Languages
• 🪄 Repo Activity
• 🙋‍♂️ We're Hiring!
• ✨ Contributors
• 📄 License

📖 Documentation

• DeepWiki — Full Codebase Documentation
• Bug Bounty Rules
• Security Policy

🗂 Project Structure

This is a monorepo managed with Yarn workspaces.

app-monorepo/
├── apps/
│   ├── desktop/        # Electron desktop app (macOS, Windows, Linux)
│   ├── ext/            # Browser extension (Chrome)
│   ├── mobile/         # React Native mobile app (iOS, Android)
│   ├── web/            # Web application
│   └── web-embed/      # Embeddable web component
├── packages/
│   ├── components/     # Shared UI component library
│   ├── core/           # Core business logic & crypto utilities
│   ├── kit/            # Main UI kit
│   ├── kit-bg/         # Background service kit
│   ├── qr-wallet-sdk/  # QR-code hardware wallet SDK
│   └── shared/         # Shared utilities, constants, and types
├── development/        # Dev tooling & scripts
├── patches/            # Dependency patches
└── docs/               # Documentation & i18n

🚀 Getting Onboard

Prerequisites: Node.js >= 22, Yarn 4.x (bundled via Corepack), Git LFS

git clone https://github.com/OneKeyHQ/app-monorepo.git
cd app-monorepo
yarn
yarn app:web    # starts dev server at http://localhost:3000

📱 Platform-specific requirements

• iOS: Xcode >= 13.3
• Android: JDK >= 11

🧑‍💻 Development

Run these commands from the root directory:

🏡 Community & Enterprise Edition

• 🏡 🧔🏻‍♂️ Community Edition — Free forever for individuals and open-source communities.
• 🏦 💼 Enterprise Edition — Coming soon. Star this repo to get notified when it's ready.

💡 Support

• Community Forum — Help with building, best practices discussion.
• GitHub Issues — Bug reports and errors.

🔰 Security

• Please read the Bug Bounty Rules, we have detailed the exact plan in this article.
• Report suspected vulnerabilities privately to dev@onekey.so or via BugRap.
• Please do NOT create publicly viewable issues for suspected security vulnerabilities.
• As an open source project, although we are not yet profitable, we try to give some rewards to white hat hackers who disclose vulnerabilities to us in a timely manner.
• See SECURITY.md for full details.

💬 Docs in Your Languages

🪄 Repo Activity

🙋‍♂️ We're Hiring!

We're hiring for remote roles worldwide — global pay, ESOP for everyone, open-source culture.

👉 View all open positions

Why join OneKey?

English	中文
🌍 Remote (Live anywhere)	🌍 远程 (生活在哪个城市都可以)
💰 Global Pay (Literally)	💰 全球一致的薪酬 (真的)
📈 ESOP (For everybody)	📈 ESOP 计划
🔓 Open Source (As you see)	🔓 开源 (如你所见)
🤝 Awesome Colleagues (Hell Yeah!)	🤝 超级棒的同事 (爽呆!)

✨ Contributors

📄 License

This project is licensed under the OneKey Standard Source License (O-SSL).