Code Monkey home page Code Monkey logo

bible_api's Introduction

bible_api

This is a Ruby web app that serves a JSON API for public domain and open bible translations.

Using It

This app is served from bible-api.com, which anyone can use.

With Curl and JQ

→ curl -s https://bible-api.com/John+3:16 | jq
{
  "reference": "John 3:16",
  "verses": [
    {
      "book_id": "JHN",
      "book_name": "John",
      "chapter": 3,
      "verse": 16,
      "text": "\nFor God so loved the world, that he gave his one and only Son, that whoever believes in him should not perish, but have eternal life.\n\n"
    }
  ],
  "text": "\nFor God so loved the world, that he gave his one and only Son, that whoever believes in him should not perish, but have eternal life.\n\n",
  "translation_id": "web",
  "translation_name": "World English Bible",
  "translation_note": "Public Domain"
}

With Ruby

→ ruby -r open-uri -r json -r pp -e "pp JSON.parse(URI.open('https://bible-api.com/John+3:16').read)"
{"reference"=>"John 3:16",
 "verses"=>
  [{"book_id"=>"JHN",
    "book_name"=>"John",
    "chapter"=>3,
    "verse"=>16,
    "text"=>
     "\n" +
     "For God so loved the world, that he gave his one and only Son, that whoever believes in him should not perish, but have eternal life.\n" +
     "\n"}],
 "text"=>
  "\n" +
  "For God so loved the world, that he gave his one and only Son, that whoever believes in him should not perish, but have eternal life.\n" +
  "\n",
 "translation_id"=>"web",
 "translation_name"=>"World English Bible",
 "translation_note"=>"Public Domain"}

Hosting it Yourself

If you want to host this application yourself, you'll need a Linux server with Ruby, Redis, and MySQL (or MariaDB) installed. Follow the steps below:

  1. Clone the repo:

    git clone https://github.com/seven1m/bible_api
    cd bible_api
    git submodule update --init
    
  2. Install the dependencies:

    gem install bundler
    bundle config --local deployment true # optional, but prefered on a server
    bundle install
    
  3. Create the database and import the translations:

    mysql -uroot -e "create database bible_api; grant all on bible_api.* to user@localhost identified by 'password';"
    export DATABASE_URL="mysql2://user:password@localhost/bible_api"
    export REDIS_URL="redis://localhost:6379"
    bundle exec ruby import.rb
    
  4. Host the app with Passenger

    ... or run bundle exec ruby app.rb if you are just testing.

Copyright

Copyright Tim Morgan. Licensed under The MIT License (MIT). See LICENSE for more info.

bible_api's People

Contributors

seven1m avatar dependabot[bot] avatar gazayas avatar bonniesimon avatar joshdance avatar jrichter avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.