Skip to content

Latest commit

 

History

History
177 lines (121 loc) · 9.22 KB

README.md

File metadata and controls

177 lines (121 loc) · 9.22 KB
Raw

OneKey - Open Source Crypto Wallet

Github Stars Version Last commit Issues Pull Requests Discord Twitter Follow

Appstore Playstore

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.

Star this repo

🚀 Getting Onboard

  1. Install node.js LTS version (>= 16)
  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 web: Develop web mode, which starts a static server on port 3000 locally
  • yarn ios: connect to iphone device via USB for development debugging
  • yarn android: develop android
  • yarn desktop: development in desktop mode
  • yarn ext: development in extension mode

🛠 Build for production

Execute the following commands in the root directory and build target for production. Make sure each platform starts correctly and environment variables are configured correctly. For expo build please read this doc to complete some prerequisites first.

  • web: cd packages/web && yarn build, build the static files at packages/web/web-build, for production build, see release-web.yml job for details.
  • ios: use expo server to build, see release-ios.yml job for details.
  • android:
    • use expo server to build, see release-android.yml job for details.
    • or use cd packages/app/android && ./gradlew aR to build in local.
  • desktop: : cd packages/desktop && yarn build, see release-desktop.yml job for details.
  • ext: cd packages/ext && yarn build:all, see release-ext.yml job for details.

🗂 Multi-repository directory structure

The repositories are organized using the monorepo model to keep the code on different ends centralized and unaffected, while making it as reusable as possible during the packaging and compilation process

  • packages/components holds UI components
  • packages/kit holds reusable page-level UI content
  • packages/app APP code
  • packages/desktop Desktop electron code
  • packages/web web-side code
  • packages/ext chrome extension & firefox addon code

🧲 Install dependencies

Each subdirectory under the packages/ directory is a separate project, and the corresponding monorepo name is the value of the name field in the corresponding directory package.json.

When you need to install a dependency for a subdirectory, just use yarn workspace @onekeyhq/web add axios. With a prefix like yarn workspace @onekeyhq/web, the axios module can eventually be installed in the root directory in the web subproject.

Some of the dependencies have native parts, so you need to go into the packages/app/ios directory and do a pod install after installing the JS dependencies.

😷 Common problems

  1. The app does not start

For any environment, module and dependency issues in the startup phase, it is recommended to use the command yarn clean in the root directory first. The command will clear all sub-dependencies, as well as the module cache of yarn, the cache of tools such as metro / babel, and then restart the project to try.

  1. Failed to run some post install scripts

Sorry, we only develop on macOS and haven't tested on other operating system platforms, so there may be some compatibility issues with some scripts. If you encounter script running errors on a Windows platform, we suggest you try using a Unix-like environment, such as WSL.

🕋 Roadmap

Check out where we are now!

Roadmap of OneKey

💬 Docs in your languages

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

🔰 Security

  • Please read Bug Bunty Rules, we have detailed the exact plan in this article.
  • Please report suspected security vulnerabilities in private to dev@onekey.so
  • 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!

    ⚖️ License

    OneKey is available under the Apache-2.0 license license. Free for commercial and non-commercial use.