Install / Getting Started

Save articles. Read offline. Your data, your control.

Install & Build Guide

Get Stash It on your device or build it from source.

📦 Install via Obtainium (Recommended)

Stash It is not published to Google Play Store. We recommend using Obtainium to manage self-developed apps directly from GitHub releases.

  1. Install Obtainium on your Android device
  2. Add Stash It: https://github.com/cmwen/stash-it-app
  3. Obtainium will automatically check for updates and notify you

Or download APKs manually from GitHub Releases.

Build from Source - Prerequisites

  • Flutter SDK 3.10.1 or higher
  • Dart 3.10.1 or higher
  • Java 17 or higher (for Android builds)
  • Android Studio or Android SDK
  • Node 18+ (for the website, not required for the app)

Clone the Repository

git clone https://github.com/cmwen/stash-it-app.git
cd stash-it-app

Install Dependencies & Generate Code

Stash It uses Drift (SQLite) and Riverpod with code generation. Run these commands before the first build:

# Get dependencies
flutter pub get

# Generate database and provider code
dart run build_runner build --delete-conflicting-outputs

Run Locally

Run on a connected Android device or emulator:

flutter run

Build Release Artifacts

flutter build apk         # Android APK (62MB, ~24s)
flutter build appbundle   # Play Store (Android App Bundle)

Note: Build times optimized in v1.6.0+. Requires Java 17+

Run Tests

flutter test              # Run all tests
flutter test --coverage   # With coverage
flutter analyze           # Static analysis

Project Structure

lib/
├── main.dart             # App entry point
├── core/
│   ├── router/           # GoRouter navigation
│   └── theme/            # Material 3 theming
├── features/
│   ├── articles/         # Save, read, manage articles
│   └── settings/         # App preferences
└── shared/
    └── widgets/          # Reusable components

Website (Optional)

To work on the documentation website:

cd astro
npm install
npm run dev

Need Help?

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