Menu

Tree [b57fc9] master beta /
 History

HTTPS access


File Date Author Commit
 .github 2024-06-16 AIC Web Tech AIC Web Tech [1fc159] Book list hanging improvements
 app 2025-06-29 AIC Web Tech AIC Web Tech [b57fc9] BSS-211: Fix issues with Use Config Caching config
 bibles 2025-02-18 AIC Web Tech AIC Web Tech [efee44] Correcting copyright / research status on Bibles
 bootstrap 2025-01-01 AIC Web Tech AIC Web Tech [f3432e] Work on db backup / packaging
 config 2025-06-29 AIC Web Tech AIC Web Tech [b57fc9] BSS-211: Fix issues with Use Config Caching config
 database 2025-04-09 AIC Web Tech AIC Web Tech [4c7782] MY fixes, beginning of API requirements action
 public 2025-06-15 AIC Web Tech AIC Web Tech [64ff7b] v 6.0.5: Fixed issue deleting cached rendered f...
 resources 2025-06-15 AIC Web Tech AIC Web Tech [64ff7b] v 6.0.5: Fixed issue deleting cached rendered f...
 routes 2018-03-02 AIC Web Design AIC Web Design [83b560] API: Beginning work on backend login / pw reset
 storage 2015-12-09 Luke M Luke M [040fb5] BSS API (Laravel) Initial Commit
 tests 2025-06-29 AIC Web Tech AIC Web Tech [b57fc9] BSS-211: Fix issues with Use Config Caching config
 .env.example 2021-12-31 AIC Web Tech AIC Web Tech [973512] Bugfixes / tweaks for deleting Bibles
 .env.example-cli 2019-04-17 AIC Web Design AIC Web Design [7012e4] UPdating installation docs, pt 1
 .gitattributes 2019-04-17 AIC Web Design AIC Web Design [a59753] Forcing .txt files to have windows line endings
 .gitignore 2025-01-01 AIC Web Tech AIC Web Tech [f3432e] Work on db backup / packaging
 artisan 2023-08-12 AIC Web Tech AIC Web Tech [80bc84] Stub of USX importer
 changelog.txt 2025-06-29 AIC Web Tech AIC Web Tech [b57fc9] BSS-211: Fix issues with Use Config Caching config
 composer.json 2025-03-30 AIC Web Tech AIC Web Tech [243c6b] Laravel 12
 composer.lock 2025-04-12 AIC Web Tech AIC Web Tech [b9e259] Readying 6.0 release
 composer.phar 2025-04-12 AIC Web Tech AIC Web Tech [b9e259] Readying 6.0 release
 gulpfile.js 2023-08-12 AIC Web Tech AIC Web Tech [80bc84] Stub of USX importer
 index.php 2023-12-16 AIC Web Tech AIC Web Tech [72f2bd] Removing subdomain requirement, pt1
 install 2019-01-12 AIC Web Design AIC Web Design [8fc310] Installer / packer - fixed some issues
 license.txt 2019-04-19 AIC Web Design AIC Web Design [142873] Tweaking some text files
 pack 2025-04-19 AIC Web Tech AIC Web Tech [0424ac] v6.0 GA
 package.json 2023-08-12 AIC Web Tech AIC Web Tech [80bc84] Stub of USX importer
 phpspec.yml 2023-08-12 AIC Web Tech AIC Web Tech [80bc84] Stub of USX importer
 phpunit 2024-05-05 AIC Web Tech AIC Web Tech [7a0065] BSS-84: Rebuilding book list seeds
 phpunit.xml 2025-03-23 AIC Web Tech AIC Web Tech [1c6bb2] Laravel 11 pt 1
 phpunit.xml.bak 2025-03-23 AIC Web Tech AIC Web Tech [1c6bb2] Laravel 11 pt 1
 phpunitall 2025-03-30 AIC Web Tech AIC Web Tech [243c6b] Laravel 12
 phpunitallserial 2025-03-30 AIC Web Tech AIC Web Tech [243c6b] Laravel 12
 pushmain 2023-09-04 AIC Web Tech AIC Web Tech [2bb499] Pushmain
 pushtags 2024-03-03 AIC Web Tech AIC Web Tech [ce765c] BSS-58: Common word prevention
 readme.md 2025-04-19 AIC Web Tech AIC Web Tech [0424ac] v6.0 GA
 readme.txt 2025-04-19 AIC Web Tech AIC Web Tech [0424ac] v6.0 GA
 server.php 2023-08-12 AIC Web Tech AIC Web Tech [80bc84] Stub of USX importer
 uninstall 2017-03-22 AIC Web Design AIC Web Design [1fa566] API-84: Tweaking install scripts
 update 2017-03-22 AIC Web Design AIC Web Design [420c41] API-84: More tweaks

Read Me

Bible SuperSearch API

BibleSuperSearch.com

Bible SuperSearch Webservice API built using the Laravel framework.
This API, when combined with a User Interface (UI), allows you to use Bible SuperSearch entirely on your website, not dependent on ours.

This software includes the following:

  • Full Bible search engine functionality
  • Webservice API for accessing this functionality
  • API documentation
  • Administrative backend
  • Installer

This does NOT include:

  • A User Interface (UI) for the Bible search engine

We reccommend our pre-built user interface, which is available both as a universal client and as a WordPress plugin.
These can be downloaded here: Download
You also have the option to build your own.

Official Documentation

Server Requirements:

  • PHP >= 8.2.0
  • MySQL
  • mod_rewrite (Apache2) or equivalent
  • BCMath PHP Extension
  • Ctype PHP Extension
  • Fileinfo PHP extension
  • gd PHP extension
  • JSON PHP Extension
  • Mbstring PHP Extension
  • OpenSSL PHP Extension
  • PDO PHP Extension
  • PDO_MYSQL PHP Extension
  • Tokenizer PHP Extension
  • XML PHP Extension
  • Zip PHP Extension
  • SQLite3 PHP Extension
  • Composer

Also, it is highly recommended to have a dedicated domain or subdomain for this API.

Installation (Web Browser):

(Recommended) Download the official release, and follow the instructions in it's readme.txt

Installation (CLI):

NOTE: THIS CLI INSTALLATION IS NOT OFFICIALLY SUPPORTED AT THIS TIME

  • Clone this GIT repository into a directory (/path/to/biblesupersearch_api)
  • Rename .env.example-cli to .env
  • Enter your database connection information in .env. You may wish to set other configs as well at this time.

From the Bible SuperSearch API directory, run:

./install

This will set up most of the application.
However, it will not install any Bible modules.

See the php artisan commands for Bibles

Install and enable ALL available Bibles:

php artisan bible:install --all --enable
  • Now, point a subdomain (https://biblesupersearch-api.your-domain.com) to path/to/biblesupersearch_api/public
  • Point your Bible SuperSearch client software to the subdomain.
    • Standalone
      In config.js, set "apiUrl": "https://biblesupersearch-api.your-domain.com",
    • Word Press plugin
      On the Bible SuperSearch config page (https://your-domain.com/wp-admin/options-general.php?page=biblesupersearch)
      Set API URL to your subdomain (https://biblesupersearch-api.your-domain.com)

Documentation for using the API can be found at this API URL once installed.

Contributing

Thank you for considering contributing to Bible SuperSearch. If you find any bugs, please contact us.

License

The Bible SuperSearch API is open-sourced software licensed under the GNU General Public License (GPL) V3 or Greater

This SOFTWARE is made available FREE of charge, and is licensed for NON-COMMERCIAL use only.

Matthew 10:8 freely ye have received, freely give. - Jesus

Any commercial use requires a commercial license. Commercial use includes:

  • Putting the SOFTWARE behind a paywall
  • Charging others to access or use the SOFTWARE
  • Selling the SOFTWARE for any amount, whether by itself or bundled with other software. This includes charging for shipping, handling or installation.
  • Using the SOFTWARE as a gift to solicit donations.
  • Incorporating into third party software which is NOT compatible with the GNU GPL. See GNU License Compatibility
  • Any other use which would violate the GNU GPL

Please see full license at https://www.biblesupersearch.com/license/

Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.