-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into test/add-e2e-security-alert-api
- Loading branch information
Showing
167 changed files
with
10,435 additions
and
5,845 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -39,18 +39,35 @@ git clone [email protected]:MetaMask/metamask-mobile.git && \ | |
| cd metamask-mobile | ||
| ``` | ||
|
|
||
| **Firebase Messaging Setup** | ||
| ### **Firebase Messaging Setup** | ||
|
|
||
| Before running the app, keep in mind that MetaMask uses FCM (Firebase Cloud Message) to empower communications. Based on this, as an external contributor you would preferably need to provide your own FREE Firebase project config file with a matching client for package name `io.metamask`, and update your `google-services.json` file in the `android/app` or `GoogleService-Info.plist` file in the `ios` directory. | ||
| MetaMask uses Firebase Cloud Messaging (FCM) to enable app communications. To integrate FCM, you’ll need configuration files for both iOS and Android platforms. | ||
|
|
||
| #### **Configuration Files Required** | ||
| - **`GoogleService-Info.plist`** (iOS) | ||
| - **`google-services.json`** (Android) | ||
|
|
||
| These files are essential for FCM integration and are automatically generated when running: `yarn start:ios` or `yarn start:android` | ||
|
|
||
| **External Contributors** | ||
| In case you don't have FCM account, you can use `./android/app/google-services-example.json` for Android or `./ios/GoogleServices/GoogleService-Info-example.plist` for iOS and follow the steps below to populate the correct environment variables in the `.env` files (`.ios.env`, `.js.env`, `.android.env`), adding `GOOGLE_SERVICES_B64_ANDROID` or `GOOGLE_SERVICES_B64_IOS` variable depending on the environment you are running the app (ios/android). | ||
|
|
||
| As an external contributor, you need to provide your own Firebase project configuration files: | ||
|
|
||
| 1. Create a Free Firebase Project | ||
| * Set up a Firebase project in the Firebase Console. | ||
| * Configure the project with a client package name matching `io.metamask`. | ||
| 2. Add Configuration Files | ||
| * Update the `google-services.json` and `GoogleService-Info.plist` files in: | ||
| * `android/app` (for Android) | ||
| * `ios` directory (for iOS) | ||
|
|
||
| In case you don't have FCM account, you can reference the instructions below. These instructions will generate the required `GOOGLE_SERVICES_B64_ANDROID` or `GOOGLE_SERVICES_B64_IOS` environment variables found in: `.ios.env`, `.js.env`, `.android.env`. They can be locally generated from examples files. | ||
|
|
||
| **Internal Contributors** | ||
|
|
||
| We should access the Firebase project config file from 1Password. | ||
| As an internal contributor, you can access the shared Firebase project config file from 1Password. Ask around for the correct vault. | ||
|
|
||
| The value you should provide to `GOOGLE_SERVICES_B64_ANDROID` or `GOOGLE_SERVICES_B64_IOS` is the base64 encoded version of your Firebase project config file, which can be generated as follows: | ||
| The values you should provide to `GOOGLE_SERVICES_B64_ANDROID` or `GOOGLE_SERVICES_B64_IOS` are the base64 encoded versions of the example Firebase project config files. These can also be generated locally: | ||
|
|
||
| **For Android** | ||
| ```bash | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.