- Install node.js LTS version (>= 16)
- Install yarn package management tool
- Install git lfs (some binaries are required for pulling and updating)
- To start the iOS project, make sure that the local XCode version is greater than or equal to 13.3
- 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
# Install the expo command line tool globally at first.(Be careful not to modify the version, it may cause compilation failure.)
npm install -g expo-cli@6.0.8
# Next, install all JS dependencies and submodule dependencies.
yarn
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 locallyyarn ios: connect to iphone device via USB for development debuggingyarn android: develop androidyarn desktop: development in desktop modeyarn ext: development in extension mode
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 aRto 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.
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/componentsholds UI componentspackages/kitholds reusable page-level UI contentpackages/appAPP codepackages/desktopDesktop electron codepackages/webweb-side codepackages/extchrome extension & firefox addon code
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.
- 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.
- 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.
| Available Languages |
|---|
| Simplified Chinese / ็ฎไฝไธญๆ |
| German / Deutsch |
| Japanese / ๆฅๆฌ่ช |
| French / Franรงais |
| Italian / Italiano |
npm install -g appcenter-cli
Login app-center
appcenter login
This opens a browser and generates a new API token.
Copy the API token from the browser, and paste this into the command window.
yarn code-push