Attention, please.

This code is a work in progress, and we publish it for full transparency. You can review the source code, but:

• you shouldn't just run this code without reading it, as it may have bugs or stubbed out crypto
• it might not do exactly what it says it is doing

If you really want to install Keybase, please return to the top level Readme.md for official release instructions.

Hi everyone! This folder's code is not ready for prime time. Use at your own risk (and never against production!) We are iterating quickly and a lot of the code is changing every day.

yarn install

The following yarn run commands, to build, run or package the app:

You can set environment variables for debugging:

# Build the go keybase.framework
yarn run rn-gobuild-ios

# Open workspace (not xcodeproj)
open react-native/ios/Keybase.xcworkspace

Then select the target Keybase and run.

If you get this error in the React Packager:

React packager ready.

Loading dependency graph...2017-08-01 23:06 node[58084] (FSEvents.framework) FSEventStreamStart: register_with_server: ERROR: f2d_register_rpc() => (null) (-22)
2017-08-01 23:06 node[58084] (FSEvents.framework) FSEventStreamStart: register_with_server: ERROR: f2d_register_rpc() => (null) (-22)
2017-08-01 23:06 node[58084] (FSEvents.framework) FSEventStreamStart: register_with_server: ERROR: f2d_register_rpc() => (null) (-22)
 ERROR  Error watching file for changes: EMFILE
{"code":"EMFILE","errno":"EMFILE","syscall":"Error watching file for changes:","filename":null}
Error: Error watching file for changes: EMFILE
    at exports._errnoException (util.js:1024:11)
    at FSEvent.FSWatcher._handle.onchange (fs.js:1359:9)
Loading dependency graph...Process terminated. Press <enter> to close the window

the easiest way to fix it is simply to install watchman:

brew install watchman

The above suffices for running in the simulator. To run on a real phone, first you need to get Marco to invite your Apple ID to the Keybase team. Once you accept the invite, you should be able to connect your phone to your computer and get XCode to build onto it.

However, you first have to edit react-native/ios/Keybase/AppDelegate.m to use the bundler running on your computer. Look for the comment "Uncomment for prod JS in dev mode" and follow the instructions there.

Alternatively, you could choose "Profile" instead of "Run", which does a prod build and thus doesn't need any bundler changes.

As for notifications, they don't work in the simulator at all. If you choose "Run" and build on a phone, they should just work. If you want to do a "Profile" build, look in local-debug.native.js and move config.isDevApplePushToken = true to outside its enclosing if statement.

Follow instructions at https://facebook.github.io/react-native/docs/getting-started.html to install and configure Android.

If you're installing on macOS on High Sierra, skip installing HAX. Instead, follow the instructions in https://issuetracker.google.com/issues/62395878#comment7 , i.e. put HVF = on in ~/.android/advancedFeatures.ini.

Follow instructions at https://developer.android.com/ndk/guides/index.html to install and configure the Android NDK.

Don't install Revision 16, though. Instead, go to https://developer.android.com/ndk/downloads/older_releases.html and download Revision 15c. Then unzip it, and do:

mv $ANDROID_HOME/ndk-bundle{,.r16} # if needed
mv /path/to/android-ndk-r15c/ $ANDROID_HOME/ndk-bundle

Then select "Open an existing Android Studio Project" and point it to shared/react-native/android. Not necessary to register the client dir as a VCS-controlled dir with Android studio, but may as well.

You'll get various prompts about installing various tools. You should install 'Build Tools' and any missing platforms. However, don't update the Android Gradle Plugin to 3.0.1.

Some instructions talk about the SDK Manager / AVD Manager. This is under the Tools > Android menu. You may have to wait for the Gradle to sync before they appear.

To run on the Android simulator:

# Build the go keybaselib
yarn run rn-gobuild-android

# Start the react native publisher (unlike on iOS, have to do this manually).
yarn run rn-start

Then do "Build > Make Project" and then "Run > Run 'app'".

1. Install the React Developer Tools and the Immutable.js Object Formatter extensions in your regular Chrome browser.
2. Set the following environment variables and make sure KEYBASE_PERF is unset (assuming you're using fish shell):

set -e KEYBASE_PERF
set -x KEYBASE_LOCAL_DEBUG 1
set -x KEYBASE_DEV_TOOL_ROOTS "$HOME/Library/Application Support/Google/Chrome/Default/Extensions/fmkadmapgofadopljbjfkapdkoienihi,$HOME/Library/Application Support/Google/Chrome/Default/Extensions/hgldghadipiblonfkkicmgcbbijnpeog"

(See this code for details.)

3. Run yarn run start-hot.

If you're running Chromium instead of Google Chrome, or if you've installed the extension in your non-default browser, you'll have to change the path passed to KEYBASE_DEV_TOOL_ROOTS.

If for some reason you don't want to use start-hot, you'll have to set KEYBASE_DEV_TOOL_EXTENSIONS instead of KEYBASE_DEV_TOOL_ROOTS, and you'll have to use the version subdirectory:

set -x KEYBASE_DEV_TOOL_EXTENSIONS "$HOME/Library/Application Support/Google/Chrome/Default/Extensions/fmkadmapgofadopljbjfkapdkoienihi/2.5.2_0,$HOME/Library/Application Support/Google/Chrome/Default/Extensions/hgldghadipiblonfkkicmgcbbijnpeog/1.7_0"

Note that this means you'll have to change the last path component if Chrome updates the extension, which can happen at any time. (See this code and the Electron docs for details.)

Then you can run, e.g. yarn run start.

4. Make sure to check 'Enable custom formatters' in the DevTools settings for Immutable.js Object Formatter.

If you run into weird issues with your packager this may be due to a stale cache, run this command to wipe your local cache:

yarn run rn-packager-wipe-cache

We have some custom forks of dependencies. This is usually a temporary fix and is something we want to avoid long term.

• react-navigation:
  • Keep queued transitions, fixes races with dragging and touches
  • Increase interactivity threshold so you can click while things are still animating
• electron-download
  • Add a force-use-cache option so we don't download all the time
• react-native-push-notification
  • 1 liner to add RN 0.47 support