Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/aliammari1/readrealm/llms.txt

Use this file to discover all available pages before exploring further.

The iOS client is a native Swift app built with SwiftUI, targeting iOS 15.0 and above.
iOS development requires macOS. Xcode is only available on macOS, so you cannot build or run the iOS client on Linux or Windows.

​
Prerequisites

  • macOS Ventura 13.0 or later
  • Xcode 15.0+
  • Swift 5.9+ (bundled with Xcode)
  • CocoaPods (for dependency management)
Install CocoaPods if you don’t have it: 
sudo gem install cocoapods

​
Setup

1

Clone the repository

git clone https://github.com/aliammari1/readrealm.git
cd readrealm
2

Install CocoaPods dependencies

cd "apps/ios/Application 4"
pod install
This generates an .xcworkspace file. Always open the workspace (not the .xcodeproj) after running pod install.
3

Configure the API URL

The iOS client connects to the ReadRealm backend. The base URL is defined in the Swift source files. For example, in apps/ios/Application 4/Application/Helper/AudioStreamService.swift:
AudioStreamService.swift
private let baseURL = "https://libraryapp-nest-back.vercel.app"
To connect to a local API server, update the baseURL values in the service files to point to your machine:
private let baseURL = "http://localhost:3000"
When running on an iOS Simulator, localhost resolves to the Mac’s own loopback interface, so http://localhost:3000 works when the API is running locally. On a physical device, use your Mac’s local network IP address instead (e.g., http://192.168.1.x:3000).
4

Open the project in Xcode

Open the workspace file generated by CocoaPods:
open "apps/ios/Application 4/Application.xcodeproj"
If you ran pod install, open the .xcworkspace file instead of the .xcodeproj:
open "apps/ios/Application 4/Application.xcworkspace"
5

Configure signing

In Xcode:
  1. Select the Application target in the project navigator.
  2. Go to Signing & Capabilities.
  3. Select your Team from the dropdown (requires an Apple Developer account).
  4. Update the Bundle Identifier if needed.
6

Build and run

Select a simulator or connected device from the scheme menu, then press Cmd + R (or click the Run button).To run tests:
xcodebuild test -workspace "apps/ios/Application 4/Application.xcworkspace" -scheme Runner
Or use the Task shortcut:
task ios:test

​
Supported devices

PlatformMinimum version
iPhoneiOS 15.0
iPadiOS 15.0
SimulatoriOS 15.0
The app is optimized for iOS 17.0+ and tested on iPhone 12 and later models.

Build docs developers (and LLMs) love

Get started for freeTalk to us