README.md

OneKey - Open Source Crypto Wallet

• Desktop clients: macOS, Windows & Linux
• Browser extensions: Chrome, Firefox, Edge & Brave
• Bridge

Community & Enterprise Edition

• 🏡 🧔🏻‍♂️ For Community Edition. It will always remain FREE FOREVER for open-source projects by individuals and communities.
• 🏦 💼 For Enterprise Edition. We've got this plan on the radar, but we're not quite ready yet. Just star our repo, and you'll be pinged as soon as we're all set.

Support

• Community Forum. Best for: help with building, discussion about best practices.
• GitHub Issues. Best for: bugs and errors you encounter using OneKey.
• Discord. Best for: sharing your ideas and hanging out with the community.

Repo Status

• ✅ Public: Production-ready

We really need your support, star or watch this repo for latest updates.

🚀 Getting Onboard

1. Install node.js LTS version
2. Install yarn package management tool
3. Install git lfs (some binaries are required for pulling and updating)
4. To start the iOS project, make sure that the local XCode version is greater than or equal to 13.3
5. To start the Android project, make sure that the local JDK version is greater than or equal to 11

After pulling the latest code via the git command line tool, install the project dependencies in the root directory via the yarn command

yarn

🧑‍💻 Develop

Execute the following commands in the root directory to develop different business code

• yarn app:web: Develop web mode, which starts a static server on port 3000 locally
• yarn app:ios: connect to iphone device via USB for development debugging
• yarn app:android: develop android
• yarn app:desktop: development in desktop mode
• yarn app:ext: development in extension mode

💬 Docs in your languages

Available Languages
Simplified Chinese / 简体中文
German / Deutsch
Japanese / 日本語
French / Français
Italian / Italiano

🪄 Repo Activity

🔰 Security

• Please read Bug Bunty Rules, we have detailed the exact plan in this article.
• Please report suspected security vulnerabilities in private to [email protected]
• 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.

🙋‍♂️We're Hiring!

We are hiring many roles (Remote) 👉 Click here to check all open positions
Remote (Live anywhere) Global Pay (Literally) ESOP (For everybody) Open Source (As you see) Awesome Colleagues (Hell Yeah!)	远程 (生活在哪个城市都可以) 全球一致的薪酬 (真的) 全员持股计划 (每个人都有) 开源 (如你所见) 超级棒的同事 (爽呆!)

✨ Salute!