Skip to content

Latest commit

 

History

History
277 lines (178 loc) · 8.54 KB

README.md

File metadata and controls

277 lines (178 loc) · 8.54 KB
Raw

Sylk Mobile

Sylk Mobile is part of Sylk Suite, a set of real-time communications applications using IETF SIP protocol and WebRTC specifications.

Sylk Suite consists of:

  • Sylk SIP/WebRTC application server
  • Sylk mobile push notifications server
  • Sylk desktop client for Windows, Linux and MacOS
  • Sylk mobile client for Apple iOS and Google Android
  • Web page for WebRTC enabled browsers
  • Mobile client API development SDK
  • Desktop client API development SDK

Home page

License

Sylk mobile licensed under GNU General Public License version 3. A copy of the license is available at http://www.fsf.org/licensing/licenses/gpl-3.0.html

Copyright 2022 AG Projects

Availability

Features

  • 1-to-1 audio and video calls
  • Encrypted end-to-end messaging
  • Encrypted end-to-end file transfers
  • Synchronization of multiple devices
  • Multiparty conferencing for all supported media
  • Call history entries management
  • Native address book lookup
  • Native OS telephony integration
  • Support for multiple devices in parallel
  • Support for multiple cameras
  • Support for landscape and portrait modes
  • Support for tablets and phones
  • Interoperable with SIP clients
  • Receive calls from the web
  • Support for Self Sovereign Identity (SSI)

Messages are encrypted end-to-end using OpenPGP.

File transfer are encrypted end-to-end using OpenPGP whenever possible.

SSI support is based on Hyperledger provided by Indy and Animo SDKs.

Credits

Financial support from:

People

  • Adrian Georgescu - Project lead
  • Saúl Ibarra Corretgé - Inception architect / original idea
  • Tijmen de Mes - API, Conference, Chat and desktop features
  • Dan Jenkins - WebRTC and React Native mechanic
  • Michiel Leenaars - Strategic guidance
  • Alexander Blom - SSIcomms partnership
  • Karim Stekelenburg - Animo SDK integration

Running dependencies

  • Generic SIP infrastructure

Developing dependencies

Getting Started

Building dependencies

Install

Follow the Getting Started guide as much as you can but not everything will be explained. No install docs will be listed here for each tool as they'll change, go and check them out yourself.

Updating the app

Yarn can be a bit of a pain, especially when a git dependency changes.

To be sure you're running the lastest code run:

rm -rf node_modules
rm -r android/app/build
yarn cache clean
yarn
rm -rf ios/Pods
rm Podfile.lock
rm -r ~/.cocoapods
cd ios; pod setup; pod install; cd ..

You might want to bring the project back to a clean repo if you're hitting any issues.

Try it as a dry-run first

git clean -d -x --dry-run
git clean -d -x -f

XCODE 12.5 fixes

  1. https://infinitbility.com/build-failed-after-update-xcode-12.5

  2. foundation/foundation-cli#98

npm rebuild node-sass

  1. facebook/create-react-app#4540

brew install watchman or port install watchman

Running the app

Use react-native run-ios --help and react-native run-android --help to give you all you need to know. You shouldn't ever have to build from Xcode or Android Studio.

Running on the iOS Simulator

Currently we have issues running a build of ios from the cli using yarn react-native run-ios so instead, open up xcode and run it there

open ios/sylk.xcworkspace/

Running on the Android Simulator or device

If you don't have any simulators running, and don't have an android device plugged in (or available to adb) React Native will start up a simulator for you. If you have a device available (doesn't matter if its real or a simulator) this command will output to the device.

yarn react-native run-android

To see the logs of the attached Android device:

adb logcat '*:W'.

Debugging

Install https://reactnative.dev/docs/debugging#react-developer-tools

Shake the device and touch Debug.

In XCode enable debugger:

Product -> Scheme -> Edit -> Run -> Build Configuration -> Debug

Running on the iOS Device

Currently we have issues running a build of ios from the cli using yarn react-native run-ios --device so instead, open up xcode and run it there

Running on a specific Android Device

yarn react-native run-android --deviceId "DeviceId"

--deviceId [string] builds your app and starts it on a specific device/simulator with the given device id (listed by running "adb devices" on the command line).

Running without debugging

To run the app on your device without tethering it to USB:

On Android:

yarn react-native run-android --variant=release

On iOS:

Select menu Product -> Scheme -> Edit scheme andselect for Run Build Configuration = Release

Beware that iOS push tokens are still meant for sandbox unless the app is released through Apple Store.

Building the app for deployment

We use fastlane for building production versions of the app.

Fastlane can handle all the metadata around your entry into the relevant App Stores and much much more too.

Currently we have two commands - you will need to open Xcode and allow it to sync the deployment key as we allow Xcode to control that rather than do it ourselves. We could add it directly into the project with git-crypt and tell fastlane to use it to make this easier.

fastlane ios beta
fastlane android beta

Patches

We utilise the patch-package module in order to patch the react-native-callkeep module instead of maintaining a complete fork. See their README on how to make changes to the patch and how those patches get installed automatically within this project on install of npm modules.

Update sylkrts.js

yarn add -D AGProjects/sylkrtc.js

Firebase notifications reference

https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#AndroidNotification