Skip to content

Commit

Permalink
add resources for android development
Browse files Browse the repository at this point in the history
  • Loading branch information
trbutler4 committed Oct 25, 2024
1 parent 6125dd9 commit df045a3
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,6 @@
- [Hardware Signer 🚧](./overview/hardware-signing.md)

- [Getting Started 🚧](./getting-started/README.md)
- [Android Native Development 🚧](./getting-started/android-development.md)
- [Building the OS 🚧](./getting-started/building-the-os.md)
- [Rust in Android 🚧](./getting-started/rust-in-android.md)
35 changes: 35 additions & 0 deletions docs/src/getting-started/android-development.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@

# Android Development Crash Course

Because GrapheneOS (and thus Starknet Phone) is based on android, it is compatiable
with Android native applications. This will be a broad overview on how Android
development is approached in this project.

## Environment/Android Studio setup

Android applications are best developed in Android Studio or Intellij. This will
focus on Android Studio.

[Install Android Studio](https://developer.android.com/studio)

## Hello World

Below is a full intro course on building a simple android app

[First Android App codelab](https://developer.android.com/codelabs/basic-android-kotlin-compose-first-app#0)

## A More Complicated Example

This project will place a strong emphasis on Jetpack Compose.

[Jetpack Compose Docs](https://developer.android.com/develop/ui/compose/documentation)

Android provides number of examples using this approach, of which we will be
following the decisions of the JetNews example linked below.

[JetNews Example Application](https://github.com/android/compose-samples/tree/main/JetNews)

## Using Rust

In some cases (like the Beerus client) we will not be able to use Kotlin for everything in an
application. For this, follow the [rust in android guide](./rust-in-android.md)

0 comments on commit df045a3

Please sign in to comment.