Skip to content

doc: added instructions for android build #46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rileyhawk1417 wants to merge 1 commit into
base: main
Choose a base branch
from
+26 −0
Open

doc: added instructions for android build #46

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions ...ribute-to-appflowy/software-contributions/environment-setup/building-android.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# 🤖 Building Android

## Step 1: Get the tools

You need the following tools in order to get started

* Get the right android NDK for your system [supported ndk](https://github.com/android/ndk/wiki/Unsupported-Downloads#r24)
* Android NDK r24 has been tested and currently works.
* You need to extract the archive and add the directory to the path.
* Windows:
`export ANDROID_NDK_HOME=C:\ndk\24.0.8215888`
* Linux:
`ANDROID_NDK_HOME=$HOME/ndk/24.0.8215888`
* MacOS:
`export ANDROID_NDK_HOME=$HOME/ndk/24.0.821588`
* You then need to install cargo-ndk using `cargo install cargo-ndk`

## Step 2: Compile the Rust SDK

You can compile the rust SDK with the command `cargo make --profile development-android appflowy-core-dev-android`.
There is also an option of using the vscode task `AF: Build Appflowy Core_for_android`

## Step 3: Run the App

After building the SDK you can run the app from VSCode ;)