Getting Started — FeedReader Documentation

Prerequisites

macOS with Xcode installed
Xcode 8+ (Swift 3 for the iOS app)
iOS 10+ deployment target
An iPhone simulator or physical device

For the Swift Package (FeedReaderCore), you need Swift 5.9+ and the iOS 14+ deployment target.

Installation

Clone & Open

# Clone the repository
git clone https://github.com/sauravbhattacharya001/FeedReader.git
cd FeedReader

# Open in Xcode
open FeedReader.xcodeproj
        

Build & Run

Open FeedReader.xcodeproj in Xcode
Select an iPhone simulator (iPhone 5S or later)
Press ⌘R to build and run

Using the Swift Package

If you want to use FeedReaderCore in your own project:

// In your Package.swift
dependencies: [
    .package(
        url: "https://github.com/sauravbhattacharya001/FeedReader.git",
        from: "2.0.0"
    )
]
        

Or in Xcode: File → Add Package Dependencies → enter the repository URL.

Using the App

Reading Stories

On first launch, FeedReader loads BBC World News. Stories appear in a table view with titles, descriptions, and thumbnails. Tap any story to see the full description and a link to the original article.

Managing Feeds

Tap the 📡 antenna icon in the navigation bar to open the Feed Manager:

Toggle feeds — Tap a feed to enable/disable it (green checkmark = active)
Add presets — Choose from 10 built-in feeds (BBC, NPR, TechCrunch, Ars Technica, Hacker News, The Verge, Reuters)
Custom feeds — Tap + to add any RSS/Atom feed URL
Remove — Swipe left on a feed to delete it
Reorder — Tap Edit and drag to rearrange priority

Bookmarks

Swipe right on a story to bookmark/unbookmark
Tap ★ in the story detail view to toggle bookmark
Tap 🔖 in the navigation bar to see all bookmarks
Bookmarks persist across app launches

Search

Pull down on the story list to reveal the search bar. Search queries filter across story titles and descriptions in real time.

Offline Mode

When the device goes offline:

If stories were previously loaded, they're displayed from the local cache
If no cached data exists, a "No Internet" screen appears with a retry button
Network changes are detected automatically via SCNetworkReachability

Configuration

Changing Default Feeds

To change the feeds available on first launch, edit the presets array in Feed.swift:

static let presets: [Feed] = [
    Feed(name: "My Blog", url: "https://myblog.com/rss.xml", isEnabled: true),
    Feed(name: "Tech News", url: "https://technews.com/feed/"),
    // ...
]
        

Testing

Running Tests

Open FeedReader.xcodeproj in Xcode
Press ⌘U to run all tests
Or open the Test Navigator (⌘6) and run individual suites

Test Suites

Suite	Coverage	Description
`BookmarkTests`	20 cases	Bookmark add, remove, toggle, persistence, deduplication
`FeedManagerTests`	35 cases	Feed CRUD, preset loading, persistence, validation
`StoryTests`	Core model	NSCoding serialization, equality, hash
`StoryModelTests`	Extended	Edge cases, HTML stripping, URL validation
`SearchFilterTests`	Search	Title/description matching, empty queries, special characters
`XMLParserTests`	Parser	Valid XML, malformed XML, missing fields, encoding
`ViewControllerTests`	UI	View controller lifecycle, table view data source
`FeedReaderCoreTests`	SPM	Swift Package module integration tests

Test Fixtures

XML test fixtures are in FeedReaderTests/:

storiesTest.xml — Standard RSS feed with valid stories
multiStoriesTest.xml — Multiple stories for pagination/dedup testing
malformedStoriesTest.xml — Malformed XML for error handling tests
storiesTest.plist — NSCoding serialized test data

CI/CD

FeedReader uses GitHub Actions for continuous integration:

Workflow	Trigger	What It Does
`ci.yml`	Push / PR to master	Build + test on macOS with Xcode
`codeql.yml`	Push / PR / schedule	CodeQL security scanning for Swift
`pages.yml`	Push to master (docs/)	Deploy documentation site to GitHub Pages
`docker.yml`	Push / PR	Docker image build verification