Skip to content

Latest commit

 

History

History
125 lines (84 loc) · 6.04 KB

README.md

File metadata and controls

125 lines (84 loc) · 6.04 KB
Raw

Cboard Cordova - AAC communication board with text-to-speech for mobile devices

cboard-org

This is a Cordova application that wraps the original Cboard React application to bring native mobile and desktop support. The Cboard react app is maintained to support Cordova detection, setup and bindings.

Text-to-speach (TTS) support is provided via phonegap-plugin-speech-synthesis. This plugin bridges the native operating system TTS functionality to browser app, in a way that mimics W3C Web Speech API: SpeechSynthesis. It uses the android.speech.tts.TextToSpeech interface on Android.

Platforms supported:

  1. Android
  2. Electron - Windows

Before setup

You will need to modify the next files:

  • In /cboard/package.json change "homepage": "https://app.cboard.io" to "homepage": "."
  • In /cboard/public/index.html add <script src="cordova.js"></script> below <head> tag

One-time setup

  1. git submodule update - Get Cboard app
  2. npm i
  3. mkdir -p www - Make root cordova app folder
  4. cordova platform add android or cordova platform add [email protected] - Add Cordova platforms. www folder must be present.
  5. cd cboard
  6. npm i

Building Cboard (React project)

You need to build the react.js app, and after that copy un cordova project:

  1. cd cboard
  2. Release npm run build / Debug npm run build-cordova-debug
  3. cp -r ./build/* ../www
  4. cd ..

Building and running Ccboard (Cordova project)

Android:

  • cordova run android --emulator

Electron:

  • cordova build electron --release For release
  • cordova build electron --debug For enable the dev tools

Android Platform

Generate Release APK

  1. Build cordova build android --release

  2. Copy cp platforms/android/app/build/outputs/apk/release/app-release-unsigned.apk ccboard.apk

  3. Sign

    1. Generate self-signed keys keytool -genkey -v -keystore ccboard.keystore -alias ccboard -keyalg RSA -keysize 2048 -validity 100000
    2. Sign jarsigner -verbose -sigalg SHA1withRSA -digestalg SHA1 -keystore ccboard.keystore ccboard.apk ccboard

Debugging output

For emulator console.log output, you can either run in the debugging under eg. Android Studio, or in Chrome, navigate to chrome://inspect, and select the remote target that shows up once the emulator starts.

Electron Platform

You can find the documentation here

In the root folder, you will find the file settings.json where are the configurations of the BrowserWindow. This contains all the graphics options to modify the electron window.

IOS Platform

You can find the documentation here

A) Install cocoapods using sudo gem install cocoapods.

B) On Xcode open AAC Cboard.xcworkspace

  1. Select a group for the iOS sign-in certificate.

  2. Add the environment variables for the 'Google Plus Plugin' to XCODE: Open your Xcode project and select the project from the project navigator. Select the "Build Settings" tab in the main area of the window. Search for "User-Defined" in the search bar. Click the "+" button to add a new user-defined setting. Enter the name of the environment variable you want to set, such as MY_ENV_VAR. Enter the value of the environment variable you want to set, such as my-value. Save the changes.

    set the envs using values from credentials.plist file. (Obtain the file from firebase console): IOS_REVERSED_CLIENT_ID IOS_WEB_APPLICATION_CLIENT_ID

    Using this plugin, it is not possible to use the device simulator (at least for now).

  3. Some targets within pods will require enabling 'bitcode', including one in AAC Cboard => libCordova.a

  4. Set a swift-language-version >= 4.2 . This should be settled on AAC Cboard Target under swift compiler - language Close

  5. Update to recommended settings and not allow changes on 'always embed swift standards libraries' to not break the voice record feature

image

  1. To enable Facebook sign in the 'fbXXXXXXXXXXXXX' URL Scheme should be registered. In order to do it: Under AAC Cboard Target > info > URL TYPES > add a new one with our APP bundle identifier and set the 'fbXXXXXXXXXXXXX' for the URL SCHEME field.
configure_FB_login

In case to deploy for production. Under cordova-util.js from cboard app source replace the FACEBOOK_APP_ID and FACEBOOK_APP_NAME with the production values.

  1. In order to allow users to open files created by the Export feature: Edit the plist file 'AAC Cboard-Info.plist' under platforms/ios/AAC Cboard/ adding this keys and values
   <key>LSSupportsOpeningDocumentsInPlace</key>
	<true/>
   <key>UIFileSharingEnabled</key>
   <true/>

Create app size report

In order to know the size of the app before submitting it to the app store connect. Follow this steps: https://developer.apple.com/documentation/xcode/reducing-your-app-s-size#Create-the-app-size-report

Prepare the app for a run in a simulator

Some plugins cause conflict to run Cboard on an IOS simulator. Only in order to test the app delete cordova-plugin-googleplus and cordova-plugin-iosrtc running these commands. Pay attention to don't preserve these changes after the test.

  1. cordova plugin rm cordova-plugin-googleplus --save --variable WEB_APPLICATION_CLIENT_ID=${IOS_WEB_APPLICATION_CLIENT_ID} --variable REVERSED_CLIENT_ID=${IOS_REVERSED_CLIENT_ID}
  2. cordova plugin rm cordova-plugin-iosrtc