Skip to content

Repository files navigation

PaperStack logo

PaperStack

Browse, save, and read arXiv papers by category, right from your phone.

Android Kotlin Jetpack Compose Min SDK 26 MIT License


Features

  • Browse by category -- cs.AI, cs.PL, math.CO, and more
  • Save papers to a personal reading list (offline, local database)
  • Read abstracts and open PDFs directly
  • Daily feed of new arXiv submissions

Architecture

data/
  local/db/          Room database, DAOs, entities
  local/datastore/   DataStore preferences
  remote/            ArxivApiService (OkHttp + XmlPullParser)
  repository/        FeedRepository, SavedPaperRepository
domain/model/        Paper, Settings
ui/
  feed/              Feed screen + ViewModel
  detail/            Paper detail screen + ViewModel
  saved/             Saved papers screen + ViewModel
  onboarding/        Onboarding flow
  components/        Reusable Composables
  theme/             Material 3 theme
di/                  Hilt modules

Tech Stack

Layer Technology
Language Kotlin (strict null safety)
UI Jetpack Compose + Material 3
DI Hilt
Local storage Room (papers) + DataStore (settings)
HTTP + parsing OkHttp + XmlPullParser
Async Coroutines + Flow / StateFlow
Data source arXiv Atom/XML API

Getting Started

Prerequisites

  • Android Studio Ladybug or newer
  • JDK 21
  • Android SDK 36

Build & Run

./gradlew assembleDebug          # debug APK
./gradlew installDebug           # install on connected device/emulator

Test

./gradlew test                   # unit tests (JUnit5 + MockK)
./gradlew connectedCheck         # instrumented tests (device required)
./gradlew lint                   # lint checks

Documentation

Doc Description
Specs Feature specifications
ADRs Architecture decision records
PRDs Product requirements documents

Contributing

  1. Fork the repo
  2. Create a feature branch (git checkout -b feat/my-feature)
  3. Write tests first (TDD is mandatory)
  4. Commit with Conventional Commits
  5. Open a Pull Request

License

MIT

About

Browse, save, and read arXiv papers by category, right from your phone.

Resources

Code of conduct

Contributing

Stars

3 stars

Watchers

0 watching

Forks

Releases

Sponsor this project

Packages

Used by

Contributors

Languages