Skip to content

Latest commit

 

History

History
95 lines (64 loc) · 4.86 KB

README.md

File metadata and controls

95 lines (64 loc) · 4.86 KB
Raw

React-Native HMS Push FCM- Demo

Contents

1. Introduction

This demo project is an example to demonstrate the features of the Huawei React-Native Push FCM Kit Plugin.

2. Installation

Before you get started, you must register as a HUAWEI developer and complete identity verification on the HUAWEI Developer website. For details, please refer to Register a HUAWEI ID.

Creating a Project in AppGallery Connect

Creating an app in AppGallery Connect is required in order to communicate with the Huawei services. To create an app, perform the following steps:

Step 1. Set an unique Application ID on the app level build gradle file located on example/android/app/build.gradle. You should also change the package names for the manifest files in the /example/android/app/src/ directory to match with the Application ID.

<!-- Other configurations ... -->
  defaultConfig {
    // Specify your own unique Application ID (https://developer.android.com/studio/build/application-id.html). You may need to change the package name on AndroidManifest.xml and MainActivity.java respectively.
    // The Application ID here should match with the Package Name on the AppGalleryConnect
    applicationId "<Enter_Your_Package_Here>" // For ex: "com.example.mypushproject"
    <!-- Other configurations ... -->
}

Step 2. Sign in to AppGallery Connect and select My projects.

Step 3. Select your project from the project list or create a new one by clicking the Add Project button.

Step 4. Go to Project Setting > General information, and click Add app. If an app exists in the project and you need to add a new one, expand the app selection area on the top of the page and click Add app.

Step 5. On the Add app page, enter the Application ID you've defined before as the Package Name here, then fill the necessary fields and click OK.

Configuring the Signing Certificate Fingerprint

A signing certificate fingerprint is used to verify the authenticity of an app when it attempts to access an HMS Core (APK) through the HMS SDK. Before using the HMS Core (APK), you must locally generate a signing certificate fingerprint and configure it in the AppGallery Connect. You can refer to 3rd and 4th steps of Generating a Signing Certificate codelab tutorial for the certificate generation. Perform the following steps after you have generated the certificate.

Step 1: Sign in to AppGallery Connect and select your project from My Projects. Then go to Project Setting > General information. In the App information field, click the icon next to SHA-256 certificate fingerprint, and enter the obtained SHA-256 certificate fingerprint.

Step 2: After completing the configuration, click OK to save the changes. (Check mark icon)

Step 3: Enter the properties of the key you generated to the build.gradle file located on example/android/app/build.gradle.

 signingConfigs {
        config {
            storeFile file('<keystore_file>')
            keyAlias '<key_alias>'
            keyPassword '<key_password>'
            storePassword '<keystore_password>'
        }
    }

Enabling the Huawei Push FCM Kit Service

Step 1: Sign in to AppGallery Connect and select your project from My Projects. Then go to Growing > Push FCM Kit and click Enable Now to enable the Huawei Push FCM Kit Service. You can also check Manage APIs tab on the Project Settings page for the enabled HMS services on your app.

Step 2: Go to Project Setting > General information page, under the App information field, click agconnect-services.json to download the configuration file.

Step 3: Copy the agconnect-services.json file to the example/android/app/ directory of the project.

Build & Run the project

Step 1: Run the following command to install and update package info.

[project_path]> npm install @hmscore/react-native-hms-push-fcm

Step 2: Run the following command to start the demo app.

[project_path]> npm run android

3. Configuration

No.

4. Licensing and Terms

Huawei React-Native HMS Push FCM - Demo is licensed under Apache 2.0 license