Giter Club home page Giter Club logo

bibleindexer-archive's Introduction

SampleTwo

Bible Indexer

A comprehensive library for querying bible content and getting cascading dropdowns for loading books of the bible, chapters and associated verses. This is an old version.

Check out latest version of this project here

Author

Badges

MIT License InstallmentCop

Features

  • Get a bible verse
  • Get a book of the bible
  • Get all verses in a chapter
  • Generate a random bible verse
  • Get all chapters in a book of the bible
  • Get a list of all books and their abbreviations in the bible (For creating dropdowns)
  • Get all verses where a specified query string occurs in the bible
  • Get a list of numbers representing all chapters in a book of the bible (for creating dropdowns)
  • Get a list of numbers representing all verses in a chapter (for creating dropdowns)

Tech Stack

C#, .Net6.0, .NetStandard2.1,

How Do I Get Started

First, install NuGet. Then, install BibleIndexer from the package manager console:

   NuGet\Install-Package BibleIndexer.Query -Version 1.0.0

Or from the .NET CLI as:

   dotnet add package BibleIndexer.Query --version 1.0.0

Finally, import into the file:

   using BibleIndexer;

Doc Reference

Get chapters in the Book Of a bible

  • Sample Usage:
   await BibleService.GetChaptersInABookOfTheBible(bookName);   
  • Input
Parameter Type Description
bookName string Required. The name of the book of the bible e.g genesis
  • Output
Type
Task<ChaptersResponse?>

Generate a random bible verse

  • Sample Usage
   await BibleService.GenerateRandomBibleVerse();
  • Output
Type
Task<BibleVerseResponse?>

Get all books of the bible

  • Sample Usage
   await BibleService.GetAllBooksOfTheBible();
  • Output
Type
Task<object>

Get all verses and verses dropdown in a chapter of the bible

  • Sample Usage
   await BibleService.GetAllVersesInAChapterOFTheBible(request);
  • Input
Parameter Type
request GetBibleVerseRequest
  • Output
Type
Task<VersesResponse?>

Get a book of the bible

  • Sample Usage
   await BibleService.GetBookOfTheBible(bookName);
  • Input
Parameter Type Description
bookName string Required. The name of the book of the bible e.g genesis
  • Output
Type
Task<BlobResponse?>

Get a bible verse

  • Sample Usage
   await BibleService.GetBibleVerse(request);
  • Input
Parameter Type
request GetBibleVerseRequest
  • Output
Type
Task<BibleVerseResponse?>

Search the bible

  • Sample Usage
   await BibleService.SearchBible(query);
  • Input
Parameter Type Description
query string Required. Query param for the search
  • Output
Type
Task<IEnumerable<BibleVerseResponse>>

Roadmap

  • Robust ReadMe

  • AI integration

  • Additional features

Contributing

Contributions are always welcome!

See contributing.md for ways to get started.

Please adhere to this project's code of conduct.

bibleindexer-archive's People

Contributors

king-alex-d-great avatar

Stargazers

 avatar

Watchers

 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.