Get Ditto • Setup • Run Locally • Build • Troubleshooting

Get Ditto

iOS	Android
[Testflight](https://testflight.apple.com/join/9M0ERlKd)	[Play Store](https://play.google.com/store/apps/details?id=chat.ditto.and) • [APK](https://gitlab.com/ditto-chat/ditto-mobile/raw/dev/android/app/release/ditto.apk)

Setup

Prerequisites

iOS	Android
[Node.js](https://nodejs.org/)
[Yarn](https://yarnpkg.com/)
[Watchman](https://facebook.github.io/watchman/) (only for development)
XCode Command Line Tools	Android Studio and the Android SDK

Procedure

	iOS	Android
1	Clone the project Note: If you want to work on the latest stable version, checkout the latest tag
2	[Set up additional features if needed](#additional-steps)
3	Run yarn in root directory
4	In root directory, run: cd ios && pod install && cd ..	N/A

Additional steps

To access some of the features of Ditto, additional configuration may be needed:

Notifications (required on Android)
1	N/A	Set up [Firebase Cloud Messaging](https://firebase.google.com/docs/cloud-messaging/android/client) and copy the google-services.json file in android/app/
2		Set up a [Matrix Push Gateway](https://github.com/matrix-org/sygnal) and set the MATRIX_PUSH_GATEWAY variables in a .env file according to the sample

Run Locally

	iOS	Android
1	[Set up the project](#setup)
2	Run yarn start
3	Open another terminal
4	Run yarn ios Note: yarn ios runs iPhone 11 Pro by default - you may need to [change this](https://facebook.github.io/react-native/docs/running-on-simulator-ios#specifying-a-device) depending on what simulators you have installed.	[Launch an Android virtual device](https://developer.android.com/studio/run/emulator) or [connect an Android device with adb](https://developer.android.com/studio/run/device)
		Run yarn and

Build

Steps to Run

	iOS	Android
1	[Set up the project](#setup)
2	Run yarn convert
3	[Run the app on a device](https://help.apple.com/xcode/mac/current/#/dev5a825a1ca)	Graphical
		Launch Android Studio and open the android folder Select Build > Generate Signed Bundle / APK… and follow the dialogs
		Command Line
		cd android and ./gradlew assembleRelease Note: You will need to [sign your app](https://developer.android.com/studio/publish/app-signing) to be able to install it on your device

Troubleshooting

Installing the APK fails

Try to disable Play Protect in the Play Store and reinstall.

Other issues

If the project is crashing and you don't know why, try running yarn reset, and follow again the steps above.

Releasing

Beta

yarn beta <ios|and>

BUMP VERSION MANUALLY BEFORE RUNNING THIS. You can have 1.0.0 (2) and 1.0.0 (5) and it'll increment that build number for you, but the patch / minor / major number needs to be manually set.

Setting the Version number

iOS: Open Xcode. Click project. Click General. Change "Version".
Android: Line ~140 of android/app/build.gradle - change the string for "versionName"