Skip to content

Install on macOS

Eliran Wong edited this page Mar 2, 2021 · 16 revisions

Set up "Unique Bible App" on macOS

Basically, you simply need to download UBA and run it if you have Python and git in place.

Steps to set up for a fresh installation:

  1. Install Python and git

  2. Download UBA

  3. Run UBA

To macOS Big Sur Users

There is a known issue of running python under macOS Big Sur + Xcode.

It is not an issue about UBA, but we wrote some notes to help users to run UBA on Big Sur at:

https://github.com/eliranwong/UniqueBible/issues/141#issuecomment-789088532

In case the following instruction does not work for you, you may want to come back to this link above.

Prepare for Installation

Get python ready!

UBA is a python-based application, so you need to have Python installed to run UBA.

Minimum Python verion for running UBA: 3.7

There are several different ways to install Python, read more information at: https://www.python.org/downloads/

Get git ready! [optional]

There are different ways to download UBA, we use git in the following example.

To install git with homebrew, run on terminal ("Applications > Utilities > Terminal.app"):

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

brew install git

Don't want to use git? You can download a zip package of UBA and unzip it instead of using git:

https://github.com/eliranwong/UniqueBible/archive/master.zip

Download UBA & Run

You simply need to download and run. Everything else will be set up for you automatically the first time you run UBA.

This means that you only need to enter 2 command lines on macOS terminal ("Applications > Utilities > Terminal.app").

To download:

git clone https://github.com/eliranwong/UniqueBible

To run:

python3 UniqueBible/uba.py

A screenshot is provided here, so you may know what to expect during the first-time setup:

UBA should look like this screenshot below the first time you run it:

Desktop Application Shortcut

A desktop shortcut "UniqueBibleApp.sh" is generated for you automatically the first time you run UBA.

The shortcut file added to your UniqueBible directory.

On mac, right click the file UniqueBibleApp.sh, select "Get Info".

In the section "Open with:", select "Terminal.app" as default.

Now, you can double-click the file "UniqueBibleApp.sh" to run the app directly.

Create a command alias [optional]:

You can run UBA with terminal without typing a fullpath, by creating an alias.

Below is an example:

This example only works if:

  1. You use bash (for example, if you use "zsh" on macOS, you need to change "/.bashrc" to "/.zshrc")

  2. The following example assumes that you install UBA in your home directory. You need to change the path if you install at a different location.

echo "alias uba='$HOME/UniqueBible/uba.py'" >> ~/.bashrc

Close and reopen your terminal app, you should then be able to run UBA with this simple command:

uba

Trouble-shooting

Our setup script automatically makes file "uba.py" executable, but in case it is not running, you may need to set permission on it manually:

[Edit the path of UniqueBible if it is not installed in your home directory!]

chmod u+x $HOME/UniqueBible/uba.py

Clone this wiki locally