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.
Run within the shared/ directory to setup our dependencies:
yarn modulesThe following yarn run commands, to build, run or package the app:
| Command | Description |
|---|---|
| start | Build a development bundle and start app |
| hot-server | Start the hot-reloading server (with start-hot) |
| start-hot | Connect to a hot-reloading server (with hot-server) |
| build-dev | Build development bundle |
| build-prod | Build prod bundle |
| package | Package app |
You can set environment variables for debugging:
| Env | Description |
|---|---|
| KEYBASE_RUN_MODE | Run mode: prod, staging, devel |
| KEYBASE_DEVEL_USE_XDG | Force Keybase to use XDG paths, can fix service socket location issues on Linux |
You can also edit ~/Library/Logs/Keybase.app.debug on macOS,
$HOME/.cache/keybase/keybase.app.debug on Linux, or
%localappdata%\Keybase\keybase.app.debug on Windows (see
platform.desktop.js) to add debug flags. In particular, you probably want
{
"showDevTools": true
}- Install react-dev-tools using npm or yarn globally
- Run it while running a dev build
see Docs
In order to update the list of countries supported by Amazon SNS, run the update-data.sh script. It will first fetch the JSON from Amazon's public S3 bucket and transform it for use in our internal country filtering code.
VSCode's ESLint extension needs to know where to look for .eslintrc. Add this to REPO/.vscode/settings.json.
{ "eslint.workingDirectories": ["shared"] }
You'll need to have watchman installed if you're running out of file descriptors:
brew install watchman