/dbp-reader

This reader is made to be used in conjunction with the Digital Bible Platform. You can see a live example at: https://live.bible.is

Primary LanguageJavaScriptMIT LicenseMIT

The Koinos Reader

Build Status Coverage Status

The Koinos Reader is a joint project of the Digital Bible Society and Faith Comes by Hearing.

QuickStart

  • This project requires Node v10 and npm v6.

  • If you do not have Node follow the installation instructions here: Node.js.

  • Follow the instructions on Digital Bible Platform to obtain an api key for the app. You will need a valid key for the app to work!

    • By default you will only have access to one bible resource. To gain access to more resources please contact the admins for the DBP and ask them to expand your access controls

  • Clone the repository:

    • git clone https://github.com/digitalbiblesociety/dbp-reader.git

  • Once you have successfully installed Node and cloned the repository run npm install to install the required dependencies

  • Next follow the steps listed below to update the files to contain your organization specific styles and information

    • Create a .env file in the root of your new project, following the pattern found in sample-env.txt add your own environment variables
      • If you don't know what bucket_id/asset_id to put for the value of DBP_BUCKET_ID you can use dbs-web as the default
      • The default value for BASE_API_ROUTE should be https://api.dbp4.org
      • You will also need to create a project for (NOTES_PROJECT_ID) that is connected to your new api key using the api. (This is required for saving notes, highlights and bookmarks).
    • Note: You will need to make sure your api key has access to the project and bucket(s) used in your .env file
    • Update the env-config.js file to only use the variables from your .env file
    • Update the files under theme_config to include your custom colors and organization information
    • Update ./static/light_theme_logo.svg and ./static/dark_theme_logo.svg to match your organization's logo
    • Update ./static/manifest.json to match your url and site theme

  • Now run npm build followed by npm start:prod for the production version of the site

    • Alternatively just run npm start for the development site

  • Finally navigate to localhost:3000 to see your newly created bible reader!

Description

A minimalist bible study application with a focus on flexibility, accessibility, and portability. It is in many ways the spiritual successor to the bible browser and the inScript projects.

Goals

  • ** Accessibility **

    • The reader is focused on supporting disadvantaged groups especially the blind or disabled. Following the recommendation of WAI and ensuring the site is built to be compatible with WAI-ARIA 1.1a will ensure that the app is easy to use and navigate
    • The reader will be heavily icon driven but given the limitations of icon-focused communication. The reader will also need to be multi-lingual. The driving text for web app itself should be translated in the top eight most common gateway languages
    • The reader will be simple and intuitive. Easy to locate settings should exist to increase font size for those with poor eyesight. It will also be possible for the users to adjust the playing speed of audio for new speakers and language learners

  • ** Robust **

    • The Reader will be fully backed by a series of tests to ensure smooth operations across multiple platforms with focus for eventual deployment as a react native app
    • The reader should leverage service workers and support some offline capabilities
    • The reader will use promises and load content asynchronously whenever it is wise

  • ** Multipurpose **

    • The Reader will be built with the intention of porting it over to mobile devices via the implementation of React Native
    • The Reader will contain components to be re-used for a few partners like gideons
    • The Reader will contain components for bible dictionaries for study and research

Contributing

  • If You are looking to contribute or just want to understand how it all works you should start with app.js in the pages folder. You can follow everything down from there.
  • The only globals used are window, document, Google Api gapi and auth2, Facebook api FB; all other modules, functions, and components are be imported at the start of each file.