{"id":15035444,"url":"https://github.com/metamask/metamask-mobile","last_synced_at":"2026-05-08T08:07:24.220Z","repository":{"id":37374758,"uuid":"141427485","full_name":"MetaMask/metamask-mobile","owner":"MetaMask","description":"Mobile web browser providing access to websites that use the Ethereum blockchain","archived":false,"fork":false,"pushed_at":"2025-04-28T12:03:21.000Z","size":495142,"stargazers_count":2370,"open_issues_count":1248,"forks_count":1222,"subscribers_count":130,"default_branch":"main","last_synced_at":"2025-04-28T12:05:32.316Z","etag":null,"topics":["android","dapps-browser","ios","javascript","metamask","react-native","web3"],"latest_commit_sha":null,"homepage":"https://metamask.io","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MetaMask.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":null,"patreon":null,"open_collective":"metamask","ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2018-07-18T11:47:08.000Z","updated_at":"2025-04-28T11:58:42.000Z","dependencies_parsed_at":"2023-09-25T07:11:06.775Z","dependency_job_id":"f7181f8c-7634-4c6f-9291-ea45d172e8fd","html_url":"https://github.com/MetaMask/metamask-mobile","commit_stats":{"total_commits":4723,"total_committers":163,"mean_commits":"28.975460122699385","dds":0.9148846072411603,"last_synced_commit":"5fe6aceffcf4c80ed1f3530282640aebcd201935"},"previous_names":[],"tags_count":319,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MetaMask%2Fmetamask-mobile","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MetaMask%2Fmetamask-mobile/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MetaMask%2Fmetamask-mobile/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MetaMask%2Fmetamask-mobile/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MetaMask","download_url":"https://codeload.github.com/MetaMask/metamask-mobile/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251311330,"owners_count":21569009,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["android","dapps-browser","ios","javascript","metamask","react-native","web3"],"created_at":"2024-09-24T20:28:43.171Z","updated_at":"2025-10-03T18:31:00.297Z","avatar_url":"https://github.com/MetaMask.png","language":"TypeScript","funding_links":["https://opencollective.com/metamask"],"categories":[],"sub_categories":[],"readme":"![MetaMask logo](logo.png?raw=true)\n\n# MetaMask\n\n[![CI](https://github.com/MetaMask/metamask-mobile/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/MetaMask/metamask-mobile/actions/workflows/ci.yml) [![CLA](https://github.com/MetaMask/metamask-mobile/actions/workflows/cla.yml/badge.svg?branch=main)](https://github.com/MetaMask/metamask-mobile/actions/workflows/cla.yml)\n\nMetaMask is a mobile wallet that provides easy access to websites that use the [Ethereum](https://ethereum.org/) blockchain.\n\nFor up to the minute news, follow our [Twitter](https://twitter.com/metamask) or [Medium](https://medium.com/metamask) pages.\n\nTo learn how to develop MetaMask-compatible applications, visit our [Developer Docs](https://docs.metamask.io).\n\nTo learn how to contribute to the MetaMask codebase, visit our [Contributor Docs](https://github.com/MetaMask/contributor-docs).\n\n## Documentation\n\n- [Architecture](./docs/readme/architecture.md)\n- [Expo Development Environment Setup](./docs/readme/expo-environment.md)\n- [Native Development Environment Setup](./docs/readme/environment.md)\n- [Build Troubleshooting](./docs/readme/troubleshooting.md)\n- [E2E Testing](./docs/readme/e2e-testing.md)\n- [Debugging](./docs/readme/debugging.md)\n- [Performance](./docs/readme/performance.md)\n- [Release Build Profiling](./docs/readme/release-build-profiler.md)\n- [Storybook](./docs/readme/storybook.md)\n- [Miscellaneous](./docs/readme/miscellaneous.md)\n- [E2E Testing Segment Events](./docs/testing/e2e/segment-events.md)\n- [Reassure Performance Testing (pilot)](./docs/readme/reassure.md)\n\n## Getting started\n\n### Using Expo (recommended)\n\nExpo is the fastest way to start developing. With the Expo framework, developers don't need to compile the native side of the application as before, hence no need for any native environment setup, developers only need to download a precompiled development build and run the javascript bundler. The development build will then connect with the bundler to load the javascript code.\n\n#### Expo Environment Setup\n\n[Install node, yarn v3 and watchman.](./docs/readme/expo-environment.md)\n\n#### Clone the project\n\n```bash\ngit clone git@github.com:MetaMask/metamask-mobile.git \u0026\u0026 \\\ncd metamask-mobile\n```\n\n#### Install dependencies\n\n```bash\nyarn setup:expo\n```\n\n#### Run the bundler\n\n```bash\nyarn watch\n```\n\n#### Download and install the development build\n\n- Expo development builds are hosted in [Runway](https://www.runway.team/) buckets and are made available to all contributors through the public bucket links below. A new build is generated every time a PR is merged into the `main` branch.\n\n- For Android:\n  - Download and install an `.apk` file from this [Runway bucket](https://app.runway.team/bucket/hykQxdZCEGgoyyZ9sBtkhli8wupv9PiTA6uRJf3Lh65FTECF1oy8vzkeXdmuJKhm7xGLeV35GzIT1Un7J5XkBADm5OhknlBXzA0CzqB767V36gi1F3yg3Uss) onto your Android device or emulator.\n- For iOS:\n  - Physical device\n    - Your test device needs to first be registered with our Apple developer account.\n    - Once registered, download and install an `.ipa` file from this [Runway bucket](https://app.runway.team/bucket/MV2BJmn6D5_O7nqGw8jHpATpEA4jkPrBB4EcWXC6wV7z8jgwIbAsDhE5Ncl7KwF32qRQQD9YrahAIaxdFVvLT4v3UvBcViMtT3zJdMMfkXDPjSdqVGw=) onto your device.\n  - Simulator\n    - Download and install an `.app` file from this [Runway bucket](https://app.runway.team/bucket/aCddXOkg1p_nDryri-FMyvkC9KRqQeVT_12sf6Nw0u6iGygGo6BlNzjD6bOt-zma260EzAxdpXmlp2GQphp3TN1s6AJE4i6d_9V0Tv5h4pHISU49dFk=) onto your simulator.\n    - Note: Our `.app` files are zipped and hosted under `Additional Artifacts` in the bucket. Since this hosting additional artifacts in public buckets is a relatively new feature, contributors may find that some builds are missing additional artifacts. Under the hood, these are usually associated with failed or aborted Bitrise builds. We are working with the Runway team to better filter out these builds and are subject to change in the future.\n\n#### Load the app\n\nIf on a simulator:\n\n- use the initial expo screen that appears when starting the development to choose the bundler url\n- OR press \"a\" for Android or \"i\" for iOS on the terminal where the bundler is running\n\nIf on a physical device:\n\n- Use the camera app to scan the QR code presented by the bundler running on the terminal\n\nThat's it! This will work for any javascript development, if you need to develop or modify native code please see the next section.\n\n### Native Development\n\nIf developing or modifying native code or installing any library that introduces or uses native code, it is not possible to use an Expo precompiled development build as you need to compile the native side of the application again. To do so, please follow the steps stated in this section.\n\n#### Native Environment setup\n\nBefore running the app for native development, make sure your development environment has all the required tools. Several of these tools (ie Node and Ruby) may require specific versions in order to successfully build the app.\n\n[Setup your development environment](./docs/readme/environment.md)\n\n#### Building the app\n\n**Clone the project**\n\n```bash\ngit clone git@github.com:MetaMask/metamask-mobile.git \u0026\u0026 \\\ncd metamask-mobile\n```\n\n##### Firebase Messaging Setup\n\nMetaMask uses Firebase Cloud Messaging (FCM) to enable app communications. To integrate FCM, you'll need configuration files for both iOS and Android platforms.\n\n###### Internal Contributor instructions\n\n1. Grab the `.js.env` file from 1Password, ask around for the correct vault. This file contains the `GOOGLE_SERVICES_B64_ANDROID` and `GOOGLE_SERVICES_B64_IOS` secrets that will be used to generate the relevant configuration files for IOS/Android.\n2. [Install](./README.md#install-dependencies) and [run \u0026 start](./README.md#running-the-app) the application as documented below.\n\n###### External Contributor instructions\n\nAs an external contributor, you need to provide your own Firebase project configuration files:\n\n- **`GoogleService-Info.plist`** (iOS)\n- **`google-services.json`** (Android)\n\n1. Create a Free Firebase Project\n   - Set up a Firebase project in the Firebase Console.\n   - Configure the project with a client package name matching `io.metamask` (IMPORTANT).\n2. Add Configuration Files\n   - Create/Update the `google-services.json` and `GoogleService-Info.plist` files in:\n   - `android/app/google-services.json` (for Android)\n   - `ios/GoogleServices/GoogleService-Info.plist` directory (for iOS)\n3. Create the correct base64 environments variables.\n\n```bash\n# Generate Android Base64 Version of Google Services\nexport GOOGLE_SERVICES_B64_ANDROID=\"$(base64 -w0 -i ./android/app/google-services.json)\" \u0026\u0026 echo \"export GOOGLE_SERVICES_B64_ANDROID=\\\"$GOOGLE_SERVICES_B64_ANDROID\\\"\" | tee -a .js.env\n\n# Generate IOS Base64 Version of Google Services\nexport GOOGLE_SERVICES_B64_IOS=\"$(base64 -w0 -i ./ios/GoogleServices/GoogleService-Info.plist)\" \u0026\u0026 echo \"export GOOGLE_SERVICES_B64_IOS=\\\"$GOOGLE_SERVICES_B64_IOS\\\"\" | tee -a .js.env\n```\n\n[!CAUTION]\n\n\u003e In case you don't provide your own Firebase project config file or run the steps above, you will face the error `No matching client found for package name 'io.metamask'`.\n\nIn case of any doubt, please follow the instructions in the link below to get your Firebase project config file.\n[Firebase Project Quickstart](https://firebaseopensource.com/projects/firebase/quickstart-js/messaging/readme/#getting_started)\n\n##### Install dependencies\n\n```bash\nyarn setup\n```\n\n_Not the usual install command, this will run scripts and a lengthy postinstall flow_\n\n#### Running the app for native development\n\n**Run Metro bundler**\n\n```bash\nyarn watch\n```\n\n_Like a local server for the app_\n\n**Run on a iOS device**\n\n```bash\nyarn start:ios\n```\n\n**Run on an Android device**\n\n```bash\nyarn start:android\n```\n\n## Development Tools\n\n### Git Hooks (Husky)\n\nThis project uses [Husky](https://typicode.github.io/husky/) to run pre-commit hooks that automatically format and lint your code before commits. The pre-commit hook runs `lint-staged` which executes:\n\n- **Prettier** - Code formatting for `*.{js,jsx,ts,tsx,json,feature}` files\n- **ESLint** - Linting and auto-fixing for `*.{js,jsx,ts,tsx}` files\n\n#### Disabling Husky Locally\n\nIf you need to disable Husky pre-commit hooks temporarily (e.g., for emergency commits or debugging), you have several options:\n\n##### Option 1: Skip hooks for a single commit\n\n```bash\ngit commit --no-verify -m \"your commit message\"\n```\n\n##### Option 2: Bypass hooks with environment variable\n\n```bash\n# Disable for current session\nexport HUSKY=0\ngit commit -m \"your commit message\"\n\n# Or disable for a single command\nHUSKY=0 git commit -m \"your commit message\"\n```\n\n**Note:** While these methods allow you to bypass the pre-commit hooks, remember that the CI/CD pipeline will still run linting checks. It's recommended to fix linting issues before pushing your changes to avoid build failures.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmetamask%2Fmetamask-mobile","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmetamask%2Fmetamask-mobile","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmetamask%2Fmetamask-mobile/lists"}