custom-branding.md

Custom branding build instruction

• Make sure you are on master branch and has pulled all the latest changes

• First you need to follow the README and make sure the app running well on your local environment

• To update app name and bundle identifier, follow these steps with order:

  • Find and replace all the matches Brekeke Phone Dev with your new app name, this will be the display name of the app when user install on their phone
  • Find and replace all the mathces Brekeke Phone with your new app name, this will be the name displays inside the app after user open up
  • Find and replace all the matches com.brekeke.phonedev with your new app bundle
  • Rename the directory tree from android/src/main/java/com/brekeke/phonedev with your new app bundle
    • For example your new app bundle is net.example.sip, the directory tree will be android/src/main/java/net/example/sip

• To update app logo, replace the following images with your new images but keep the same name:

# For the icon of the app on android, these images need to be the same size:
android/src/main/res/mipmap-hdpi/ic_launcher.png
android/src/main/res/mipmap-mdpi/ic_launcher.png
android/src/main/res/mipmap-xhdpi/ic_launcher.png
android/src/main/res/mipmap-xxhdpi/ic_launcher.png
android/src/main/res/mipmap-xxxhdpi/ic_launcher.png
# For the icon on splash launch screen on android:
android/src/main/res/mipmap-hdpi/launch_screen.png
android/src/main/res/mipmap-mdpi/launch_screen.png
android/src/main/res/mipmap-xhdpi/launch_screen.png
android/src/main/res/mipmap-xxhdpi/launch_screen.png
android/src/main/res/mipmap-xxxhdpi/launch_screen.png

# For the icon of the app on ios, these images need to be the same size:
ios/BrekekePhone/Images.xcassets/AppIcon.appiconset/icon120.png
ios/BrekekePhone/Images.xcassets/AppIcon.appiconset/icon152.png
ios/BrekekePhone/Images.xcassets/AppIcon.appiconset/icon167.png
ios/BrekekePhone/Images.xcassets/AppIcon.appiconset/icon180.png
ios/BrekekePhone/Images.xcassets/AppIcon.appiconset/icon20.png
ios/BrekekePhone/Images.xcassets/AppIcon.appiconset/icon40.png
ios/BrekekePhone/Images.xcassets/AppIcon.appiconset/icon58.png
ios/BrekekePhone/Images.xcassets/AppIcon.appiconset/icon60.png
ios/BrekekePhone/Images.xcassets/AppIcon.appiconset/icon76.png
ios/BrekekePhone/Images.xcassets/AppIcon.appiconset/icon80.png
ios/BrekekePhone/Images.xcassets/AppIcon.appiconset/icon87.png
# For the icon on splash launch screen on ios:
# If you change this launch screen image size, you may need to
#   update accordingly in ios/BrekekePhone/LaunchScreen.storyboard
ios/BrekekePhone/Images.xcassets/LaunchScreenLogo.imageset/LaunchScreen.png
ios/BrekekePhone/Images.xcassets/LaunchScreenLogo.imageset/[email protected]
ios/BrekekePhone/Images.xcassets/LaunchScreenLogo.imageset/[email protected]

# For the favicon on web
public/favicon.ico
# For the mobile startup app on web
src/assets/brand.png
src/assets/logo.png

• To update app branding color:

  • For splash screen:
    • Find and replace #74bf53 with your new color
    • Update ios/BrekekePhone/LaunchScreen.storyboard at the node <color key="backgroundColor" with your new color
  • For other in app colors:
    • Open src/components/variables.ts and update the primary color there
    • You can also update other colors their as you want

• Keystores and other credentials keys:

  • android/app/google-services.json
    • Download from your Firebase console
    • https://support.google.com/firebase/answer/7015592
  • android/keystores/development.keystore
  • android/keystores/release.keystore
    • Generate from terminal or Android Studio if you dont have any existing app. Must keep it and use the same keystore every time you build your app
    • If you have the existing app and you want to use the old bundle identifier then reuse those keystore from that existing app
    • https://developer.android.com/training/articles/keystore
    • https://stackoverflow.com/questions/3997748
  • src/api/turnConfig.ts
    • To export TURN config for WebRTC usage. Most of the cases you don't need to use TURN to establish the call. You can put export default null; in turnConfig.ts and keep the TURN feature turned off
    • https://stackoverflow.com/questions/57547378
    • https://github.com/coturn/coturn

• For the push notification and build:

  • Update google application id 22177122297 in src/api/pbx.ts
  • You may need to update the app version / build code here:
    • android/app/build.gradle search for versionCode and versionName
    • ios/BrekekePhone/Info.plist search for CFBundleShortVersionString
    • package.json search for version
  • Then try to follow some instruction in README to configure push notification and have the production build, archive, and distribution