AozoraBooks

AozoraBooks is a modern, cross-platform reading app built with Kotlin Multiplatform, designed for reading novels in the Aozora Bunko (青空文庫) format. It supports advanced layout features like ruby annotations and vertical text, and runs on Android, iOS.

⚠️ This project is in a very early stage of development.

Download

<a href="https://play.google.com/store/apps/details?id=me.andannn.aozora" target="_blank"> <img src="https://play.google.com/intl/ja/badges/static/images/badges/ja_badge_web_generic.png" width=240 /> </a> <a href="https://apps.apple.com/us/app/%E9%9D%92%E7%A9%BA%E8%AA%AD%E6%9B%B8-%E9%9D%92%E7%A9%BA%E6%96%87%E5%BA%93%E3%83%93%E3%83%A5%E3%83%BC%E3%82%A2/id6746423917" target="_blank"> <img src="https://toolbox.marketingtools.apple.com/api/badges/download-on-the-app-store/black/ja-jp?size=250x83" width=240 /> </a>

Features

• Support for Aozora Bunko HTML format, including:
  • Ruby text (<ruby>)
  • ..
• Cross-platform with shared codebase (Android / iOS)

Screenshots

<p float="left"> <img src="screenshots/template.png" width="25%" /> </p>

Tech Stack

| Layer | Tech | |----------------|--------------------------------------| | Language | Kotlin Multiplatform | | UI | Jetpack Compose Multiplatform | | Parsing | Ksoup (for HTML), custom parser | | I/O | Okio, kotlinx-io | | State Mgmt | Circuit (Composable UDF) | | Dependency Injection | Koin | | Platforms | Android, iOS |

Getting Started

Prerequisites

• Android Studio(Meerkat or newer)
• Install the Kotlin Multiplatform Plugin in Android Studio.
• Xcode(for iOS build)
• JDK(17)

Run the App (Android)

1. Connect an Android device or start an emulator in Android Studio.
2. Wait for the Gradle sync to complete successfully.
3. Add a new Android Run Configuration, and select the composeApp module.

   Android Studio usually recognizes this module automatically. If not, configure it manually.

4. Click the Run ▶️ button to launch the app.

Run the app (iOS)

1. Wait for the Gradle sync to complete successfully.
2. Add a new iOS Application Configuration in Android Studio or IntelliJ IDEA.

   Xcode project path: <project root>/iosApp/iosApp.xcodeproj
   Execution target: any simulator compatible with your installed Xcode version

3. Click the Run ▶️ button to launch the app.

Code style

This project uses ktlint.`

running ./gradlew ktLintFormat to automatically fix lint errors.

running ./gradlew spotlessApply to add copyright.

Run Tests before contributing

./gradlew allTest