BDRC Lib

A mobile application for searching through the BDRC library for the status of works.

Getting Started

The application uses Cordova to achieve cross platform deployment (Android, iOS, & web). The heart of the app is written entirely in React.

All development and deployment modules are installed.

yarn 

Development (React/browser)

The development configuration is located in the webpack.config.babel.js file. Use the following commands to build the app with a target of the Cordova www folder. http://localhost:8080

yarn run serve

This runs the webpack-dev-server, rebuilding and reloading in the browser when a change is made.

Production

First build the React app:

yarn run build

Cordova Android dev build

(You will need Android Studio and JDK 1.8)

cordova run android

NOTE: You may need to set JAVA_HOME if you are running an older JVM by default, like so on MacOS X in the case where you also have JDK 1.8.0.101: export JAVA_HOME=/Library/Java/JavaVirtualMachines/jdk1.8.0_101.jdk/Contents/Home

Cordova Android signed build

cordova run android --release -- --keystore=KEYSTORE.jks --storePassword=STORE_PASSWORD --alias=ALIAS --password=ALIAS_PASSWORD

NOTE: You may need to set JAVA_HOME if you are running a JVM other than 1.8, like so on MacOS X in the case where you also have JDK 1.8.0.152: export JAVA_HOME=/Library/Java/JavaVirtualMachines/jdk1.8.0_152.jdk/Contents/Home

IOS

npm install -g ios-deploy

Test Searches, easy to type on Tib keyboard:

བཀྲ་ཤིས་

བཀའ་མ

ཞེས་བྱ

using "$" as a prefix will access FTS.

IMPORTANT DEPLOYMENT NOTE

in config.xml the app id is unfortunately different for iOS and Android.

Android:

id="org.tbrc.bdrclibapp"

iOS:

id="io.bdrc.bdrclibapp"

You must change these before building production releases.

Technologies

For React Dev/Deployment

Yarn & npm:

https://www.npmjs.com/ https://yarnpkg.com/en/

development tooling

The development tooling consists of a number of tools for preprocessing and building the app. These include: webpack 2, cssnext/postcss, flow, babel

https://babeljs.io/ https://webpack.js.org/ http://cssnext.io/ https://flow.org/

JSDoc using documentation.js http://documentation.js.org/

more info on webpack2/cssnext https://blog.madewithenvy.com/webpack-2-postcss-cssnext-fdcd2fd7d0bd

Helpful Sublime Text Plugins SublimeLinter SublimeLinter-flow SublimeLinter-contrib-eslint Syntax Highlighting for PostCSS DocBlockr Babel Flow

deployment/javascript libraries

React https://facebook.github.io/react/

Text Encoder/Decoder Used after reading in the JSON files into BufferArrays, this library is used to convert them to UTF-8 stings that can be parsed as JSON.

This is a polyfill for the Encoding Living Standard API for the Web, allowing encoding and decoding of textual data to and from Typed Array buffers for binary data in JavaScript. https://github.com/inexorabletash/text-encoding

Onsen UI Onsen UI is used for the material UI implentation. For theming, see onsenui_css_theming_tools/css-components-src/readme.md https://onsen.io/

React SpinKit https://github.com/KyleAMathews/react-spinkit

Cordova

Plugins

https://cordova.apache.org/docs/en/latest/reference/cordova-plugin-device/ https://github.com/litehelpers/Cordova-sqlite-storage https://github.com/EddyVerbruggen/SocialSharing-PhoneGap-Plugin https://cordova.apache.org/docs/en/latest/reference/cordova-plugin-file/ https://github.com/danwilson/google-analytics-plugin https://cordova.apache.org/docs/en/latest/reference/cordova-plugin-network-information/index.html

Other Info

IOS Deployment https://cordova.apache.org/docs/en/latest/guide/platforms/ios/

Icon Generation https://www.npmjs.com/package/cordova-icon

Splash Generation https://github.com/AlexDisler/cordova-splash

NOTES

Disable CORS in browser https://vxlabs.com/2016/03/17/fixing-the-cordova-browser-platform-access-control-allow-origin-error/

/Applications/Chromium.app/Contents/MacOS/Chromium --user-data-dir=/tmp/temp_chrome_user_data --disable-web-security &

Enable Tib Keyboard

http://en.ironrabbit.org/howto