Setup scripts for the Heb12 API
api
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Daniel 82ecb97d56 Merge pull request 'Updated Readme.md' (#1) from nsturtz/api:master into master 1 month ago
bibleget @ 0154956e8e Add submodules 7 months ago
biblesearch @ 7421652cbd Update biblesearch 7 months ago
.gitignore Add essential files, and setup-bibles.sh 7 months ago
.gitmodules Add submodules 7 months ago
README.md Updated Readme.dm 1 month ago
setup-bibleget.sh Add basic setup scripts 7 months ago
setup-bibles.sh Add essential files, and setup-bibles.sh 7 months ago
setup-biblesearch.sh Fix script 4 months ago
setup.sh Add basic setup scripts 7 months ago

README.md

Heb12 API

This is the central repository for the Heb12 API. It provides easy setup for the API and all related software.

This has a set of scripts that work together to configure the API for production use.

Prerequisites:

Setup scripts:

  • bash
  • git
  • wget

bibleget:

  • Go >= 1.11

biblesearch:

  • Node.js
  • Python 3

Installation

First clone the repository:

$ git clone https://code.heb12.com/heb12/api --recursive

Note: if you want to run all of the scripts and setup a full Heb12 API, you can just run ./setup.sh.

Now set up the Bibles. This will download the Bibles if they aren’t already downloaded, and make archives for each of them.

$ ./setup-bibles.sh

If you want to set up bibleget, run ./setup-bibleget.sh, and to set up biblesearch, run ./setup-biblesearch.sh.

License

All Copyright and neighboring rights are waived from these setup scripts with the CC0-1.0 legal tool.

bibleget and biblesearch are licensed under the LGPL-3.0-or-later license (see the licenses in their respective directories).