Setup guide for mobile app

• Installation and setup
  • Prerequisites
  • Environment Variables
  • Setup firebase for push notification
  • Setup Sentry for error reporting
• Running
  • iOS - Mac is required if you wish to develop for iOS.
  • Android
• Configure and run tests

Installation and setup

Prerequisites

• Node.js
• Watchman
• Yarn

To learn more about the most up-to-date instructions, please refer to the guide available here.

Clone the repository

$ git clone git@github.com:chatwoot/chatwoot-mobile-app.git

Install dependencies

$ yarn

Environment Variables

Create .env file under root folder

SENTRY_DSN=
CHATWOOT_WEBSITE_TOKEN=
CHATWOOT_BASE_URL=https://app.chatwoot.com
JUNE_SDK_KEY=
MINIMUM_CHATWOOT_VERSION=2.16.0

• CHATWOOT_WEBSITE_TOKEN: Web widget token. Add this token only if you want to add in app support.
• CHATWOOT_BASE_URL: Replace with your self-hosted installation url.
• SENTRY_DSN: Sentry DSN URL.
• JUNE_SDK_KEY: June SDK key. We use June for analytics.
• MINIMUM_CHATWOOT_VERSION: Minimum supported Chatwoot version.

Push notification

If you are using the community edition of Chatwoot, you would now be able use the Official mobile app with push notifications without any additional configuration.

Setup Sentry for error reporting

Create a new project in Sentry

Add SENTRY_DSN value in .env file. If you want to supports native crashes, link the sentry SDK to your native projects.

Run the following command to generate the Sentry configuration.

yarn sentry-wizard -i reactNative -p ios android
cd ios && pod install

Running

iOS

• cd ios && pod install

• yarn ios

OR

Open Chatwoot.xcworkspace file under ios folder. Choose your target device and click playbutton.

Android

• yarn android

If you face any issues while setting up, please post on our GitHub or on our developer forum at Discord. Someone from the team will definitely help you.