Skip to content

Latest commit

 

History

History
69 lines (45 loc) · 2.89 KB

README.md

File metadata and controls

69 lines (45 loc) · 2.89 KB
Raw

Sefaria-Mobile

This repo contains the source code and export script to generate the content for Sefaria's iOS App AND Sefaria's Android App.

We're using React-Native, so much of the app is written in JavaScript and we deploy almost the same code to both Android and iOS. There are minor differences in native packages that we use and a small amount of native code we've written ourselves.

If you haven't already done so, install React Native for your development environment using the React Native CLI Quickstart. Follow the instructions on the "React Native CLI Quickstart" tab (not "Expo CLI Quickstart") for your operating system. You should follow the instructions for both iOS and Android. Skip the "Creating a new application" section since you'll be using this repo as the project.

Getting Started

brew install node
brew install watchman
git clone https://github.com/Sefaria/Sefaria-iOS/
cd Sefaria-Mobile                          
npm install
npm run setup
brew install cocoapods
cd ios
pod install

Google service file from Firebase

Firebase requires that you download the Google service files for Android and iOS to make Firebase work. These aren't included in the repo since they are private. For Sefaria employees, you can access these files from the Firebase Project Settings. If you don't have access to Firebase, please reach out to your friendly coworker :).

Put GoogleService-Info.plist in the ios directory. Put google-services.json in the android/app directory.

Build and run

To build and start the simulator:

From the root of the repo, run npx react-native start.
From another terminal, run npx react-native run-ios or npx react-native run-android

Alternatively for iOS, you can open /ios/ReaderApp.xcworkspace and hit run.

Local Development

Connect Simulator to Local Django Server

It's quite natural to want to test the app against a local instance of Sefaria-Project. This can be done relatively simply.

On Android

  1. Set Api._baseHost to the 10.0.2.2:8000 this is a special alias that maps to localhost on your development machine
  2. Ensure that 10.0.2.2 is in ALLOWED_HOSTS in local_settings.py in your Sefaria-Project repo.

On iOS

  1. Set Api._baseHost to the localhost:8000

Simulate Deep Linking

To simulate deep linking, use these commands in your terminal

For Android:

adb shell am start -W -a android.intent.action.VIEW -d "<INSERT_URL_HERE>" org.sefaria.sefaria

For iOS:

xcrun simctl openurl booted <INSERT_URL_HERE>

License

GPL