pawelorzech/Swoosh
1
0
Fork 0
mirror of https://github.com/pawelorzech/Swoosh.git synced 2026-03-31 20:15:41 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
Swoosh/CLAUDE.md
Paweł Orzech 7da55c4b35
feat: redesign setup screen with pulsing animated background and API key helper 
- Move inputs/button to bottom of screen for easier thumb access
- Add full-screen animated radial pulse background (3 circles with independent animations)
- Add contextual hint linking to Ghost integrations page when URL is entered
- Add pull-to-refresh and connection error handling to feed screen
- Add CLAUDE.md and restore gradle wrapper
2026-03-19 10:11:00 +01:00

2.4 KiB
Raw Blame History

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Project Overview

Swoosh is an Android microblogging client for Ghost CMS. It provides offline-capable post creation, image uploads, link previews, and scheduled publishing via Ghost's Admin API.

Build & Test Commands

./gradlew assembleDebug          # Build debug APK
./gradlew assembleRelease        # Build release APK (ProGuard enabled)
./gradlew test                   # Run all unit tests
./gradlew app:testDebugUnitTest  # Run unit tests for debug variant
./gradlew test --tests "*.MobiledocBuilderTest"  # Run a single test class
./gradlew test --tests "*.MobiledocBuilderTest.testBasicTextPost"  # Run a single test method

Robolectric is used for tests that need Android framework classes. Unit tests include Android resources (unitTests.isIncludeAndroidResources = true).

Architecture

MVVM with Repository pattern, single-module Gradle project.

Package: com.swoosh.microblog

  • data/api/ — Retrofit service (GhostApiService), JWT auth (GhostJwtGenerator, GhostAuthInterceptor), and ApiClient singleton with dynamic base URL
  • data/db/ — Room database with LocalPost entity and LocalPostDao
  • data/model/ — Three model layers: GhostPost (API), LocalPost (Room entity), FeedPost (UI display). Enums: PostStatus, QueueStatus
  • data/repository/ — PostRepository coordinates local DB and remote API; OpenGraphFetcher parses link previews via Jsoup
  • ui/ — Jetpack Compose screens (Feed, Composer, Detail, Setup, Settings) with ViewModels using StateFlow
  • worker/ — PostUploadWorker (WorkManager) handles offline queue with exponential backoff

Key data flow: Posts are saved to Room first → queued for upload → PostUploadWorker syncs to Ghost API when network is available.

Technical Details

  • Auth: Ghost Admin API keys are split into id:secret, secret is hex-decoded for HS256 JWT signing (5-min expiry)
  • Content format: Posts use Ghost's mobiledoc JSON format, built by MobiledocBuilder (supports text paragraphs and bookmark cards)
  • Credentials: Stored in EncryptedSharedPreferences (AES256-GCM) via CredentialsManager
  • API client: Base URL is configured at runtime during setup; ApiClient rebuilds Retrofit instance when URL changes
  • Min SDK 26, Target/Compile SDK 34, Kotlin 1.9.22, Java 17