Skip to content

Web Version [available OFFLINE]

Jump to bottom
Eliran Wong edited this page May 28, 2021 · 19 revisions

Web Version

You can run our desktop GUI version on Windows, macOS, Linux, ChromeOS, which supports Qt library.

You can run our Web version on any devices which has a web browser. Offline running is supported.

It may be a good choice especially if you want to want the full UBA on your mobile devices. Read more below.

Options of Running UBA on Android / iOS

There are several options to run UBA on Android devices:

  1. Native Mobile App.
  1. Hybrid Version

  • Pros: Written as a cross-platform native app, designed to be extensible in terms of resources.

  • Cons: Still in development, may be postponed indefinitely due to new development of Web Version [described below].

  • Read more at: https://github.com/eliranwong/UniqueBibleAppHybrid

  1. Web Browser Version

  • Pros: Use the same resources and codes as the UBA desktop version. Can run offline on your mobile devices. Install on one device and access from any kinds of devices having a web browser. For example, run a copy on an Android phone, and give everyone in the same room to use the app.

  • Cons: Need a third-party app, e.g. Termux or iSH, to run UBA as a http-server.

The rest of this page describe how to set up UBA as a http-server on Android / iOS devices and run with a web browser.

Running UBA http-server via Termux [Android] / iSH [iOS]

"Termux is an Android terminal emulator and Linux environment application that works directly with no rooting or setup required." Read more about Termux at: https://wiki.termux.com/wiki/Main_Page

"iSH is a project to get a Linux shell environment running locally on your iOS device, using a usermode x86 emulator." Read more at: https://ish.app/

With Termux or iSH, you can simply run UBA http-server on mobile devices.

Remarks: There are several other options on Android, we recommend Termux for its simplicity.

Setup and startup on iOS / iPhone / iPad

https://github.com/eliranwong/UniqueBible/wiki/Running-UBA-server-on-iOS

There is a known issue that iSH is slows for database access.

Setup on Android

  1. Download "Termux" from standard Play Store.

  2. Open "Termux" app after installed.

  3. Run the following commands on your Termux app to get everything ready:

pkg install root-repo

pkg install python

pkg install git

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

Startup of UBA http-server

Open Termux and run:

Remarks: It takes time for one-off automatic setup the first time UBA is launched. UBA should start up much faster after the first run.

cd UniqueBible

python uba.py http-server & disown

(Note: We use "& disown" here so that the opened terminal session won't be prevented from new input.)

You should see something like this screenshot for the first run:

Run UBA on the same device

  1. Open a web browser

  2. Enter url 'http://localhost:8080'

Run UBA from other devices

Option 1 - manual entry

  1. Open a web browser

  2. Enter url 'http://:8080'

(In our screenshot example above, the url is http://192.168.167:8080)

Option 2 - QR code

  1. Generate a QR code from the device which has the UBA http-server running, by running '.myQRcode' command or click the '.myQRcode' link on help page.

  2. Use a QR code scanner from a client-device to scan the QR code to make connection.

Support both OFFline and ONline

You can use UBA web version both offline and online.

To use the web version offline, simply install UBA on your device (mobile, laptop or desktop) and access it with a web browser using http://localhost:8080

To share the installed app with other users. For example, you have your UBA installed on your phone, bring it to a bible study group, and inform others to connect to UBA on your phone using your phone ip or QRcode.

Open a bible passage

You can either:

- Use selection menu and chapter navigation buttons available on default layout

- Simply enter a passage, e.g. John 3:16, into the command entry. [Remarks: Abbreviations works, e.g. Jn 3:16.]

- Use Bible Navigation menu, described below.

The '*' Bible Navigation and Search Menu

You can open our web version bible navigation and search menu by clicking the '*' button.

With this menu, you can:

- open a bible version or a passage

- open a UBA feature or resource specifically related to the selected passage.

- search a bible / multiple bibles

Change layout

From default layout, you can see a 'layout' button, click it to change to our 'mini' layout.

Our 'mini' layout is designed to be as mini as possible to save space for use on mobile devices.

To change back to default layout from 'mini' layout, either:

- enter '.layout' command

- click '?' button and click on '.layout' link to make a swap between available layouts.

Change theme

There are two available themes, 'default' and 'dark'.

To do a swap between the themes, either:

- enter '.theme' command

- click '?' button and click on '.theme' link available on the help page

An example of dark theme display:

Command line entry

One unique feature of UBA desktop version is that users can enter a single line command to have quick access to biblical resources.

You can do the same with our web version by entering a command in the command input.

For example, the following screenshot is taken after running 'compare:::KJV_CUV:::Jn 3:16'.

For supported http-server built-in commands and UBA commands, read our help page by clicking the '?' button.

Access UBA features WITHOUT a command line

Click the '?' button for help page, which contains links to common features. There are annotations right next to available links. Therefore, you may use the help page as a menu for quick access of different UBA features.

It is highly recommended users read the help page to get familiar what the UBA app is up to.

Library

You can displays a library page with links to installed resources, by either:

- Click the "Library" button on the default layout.

- Enter '.library' in command entry.

- Click '?' button to open our help page and click the '.library' link.

Use those links to quickly access to biblical resources.

Search

Find available search options by either:

- Click the "Search" button on the default layout.

- Enter '.search' in command entry.

- Click '?' button to open our help page and click the '.search' link.

Configure Faviourite Bibles

Configure config.favouriteBible, config.favouriteBible2, config.favouriteBible3 to customise bible buttons on default layout or links on mini layout side navigation bar.

If config.developer is set to True, you can run a command to set a favourite bible, e.g.

_setconfig:::favouriteBible2:::'BSB'

Download Resources

To display links of downloadable resources, either:

- Enter '.download' in command entry.

- Click '?' button to open our help page and click the '.download' link.

Import Third-party resources

Download and place third-party resources in this directory and run ".import" command to import supported resources.

Read more about third-party resources at: https://github.com/eliranwong/UniqueBible/wiki/Third-party-resources

Automation

You may place the following line in file '/data/data/com.termux/files/home/.bashrc':

python /data/data/com.termux/files/home/UniqueBible/uba.py http-server & disown

Update UBA

Enter ".update" in command entry.

Remarks: If latest changes involve new configurations, you may need to restart manually.

Clone this wiki locally