guipmourao / fetch

https://fetch.bible

fetch(bible)

All the source code for everything fetch(bible).

You should read all of the docs on the website before reading this, as they explain how the platform works. This is not a typical platform, as the hosted portion is simply static files and the "API" is really a client-side module that does things an API would usually do.

Components

• collector: A node CLI for managing a private collection of Bible translations
• collection: A test collection that .bin/collector will generate during development
• client: A browser/Node module that can interact with a collection in an API-like way
• app: A simple generic Bible reading app that can be embedded in another website/app
• site: Website for fetch.bible that includes the documentation

Development setup

If you want to use the platform for an app, check out the documentation on how to use it. The following setup is only for developers who wish to improve the platform itself:

# Install modules
.bin/setup

# Setup a test collection with a few translations
# This will take 5-10 mins to discover and convert translations to required formats
.bin/test_collector

# Build the client which other components rely on
.bin/build_client

# Serve the collection (so app and site can use it)
.bin/serve_collection

# Serve the app and/or site (while collection is still being served)
.bin/serve_app
.bin/serve_site