getting-started.md

Getting started

How developers install tooling and run Radixel in development.

Prerequisites

Tool	Requirement	Notes
Bun	≥ 1.0	Primary package manager and script runner
Node	≥ 24	Declared in package.json engines
Git	any recent	Clone this repo
Android Studio	latest stable	SDK, emulator, or USB device
JDK	17+ (typical for RN/Gradle)	Used by Android Gradle + keytool
Xcode	latest stable	macOS only — iOS simulator / device
CocoaPods	current	iOS native deps after prebuild

Optional:

• WSL2 on Windows — wsl:prebuild-android / build:android:wsl.
• Expo account — only for optional EAS Build / Submit. Not required for local debug or a local Play AAB. JS OTA does not use EAS Update.

This app uses a development build (expo-dev-client in devDependencies), not Expo Go. Produce a native binary once, then use Metro against that client.

Clone and install

Clone Ax108/radixel:

git clone https://github.com/Ax108/radixel.git
cd radixel
bun install

Generate native projects

android/ and ios/ are generated (gitignored). Create them with Expo prebuild:

bun run prebuild              # both (ios skipped on Windows)
bun run prebuild:android      # Android only
bun run prebuild:ios          # macOS

If .env has complete ANDROID_UPLOAD_* keys, Android prebuild injects Play upload-key signing. Without them, debug signing still works.

First run — Android

1. Start an emulator or USB device.
2. Build and install the debug APK:

bun run android

Or Gradle debug APK after prebuild:

bun run build:android:wsl
# → android/app/build/outputs/apk/debug/app-debug.apk

3. Start Metro:

bun run start
# or
bun run devClear

Open the installed Radixel (com.astrax.radixel) app; it should connect to Metro.

First run — iOS (macOS)

bun run prebuild:ios
bun run ios
bun run start

Quality gate

bun verify

Runs oxlint, oxfmt check, tsc, tsc:app, and Jest.

Next: folder-structure.md, deployment-local.md.