Install / Getting Started

Local-first AI-assisted book creation and reading

Install & build

Get ReadForge running locally, or build release artifacts from source.

Prerequisites

  • Flutter SDK 3.10.1+
  • Dart 3.10.1+
  • Java 17+ (Android builds)
  • Android Studio / Android SDK (Android device or emulator)
  • Node 18+ (only if you work on the website in astro/)

Clone the repository

git clone https://github.com/cmwen/read-forge-app.git
    cd read-forge-app

Run locally

  1. Get dependencies: flutter pub get
  2. Run: flutter run
  3. Optionally specify a device:
flutter run -d android

Build release artifacts

flutter build apk         # Android APK
    flutter build appbundle   # Play Store (AAB)

Run tests

flutter test
    flutter test --coverage

Website (optional)

If you need to work on the repository website, switch to the astro/ directory and run:

cd astro
    npm install
    npm run dev

Need more help?

Open an issue or pull request on GitHub. For CI or release problems, check .github/workflows/.