https://github.com/ogubuikeAlex/BibleIndexer-v2
A comprehensive library for querying bible content and getting cascading dropdowns for loading books of the bible, chapters and associated verses.
https://github.com/ogubuikeAlex/BibleIndexer-v2
api bible bible-api bible-study bible-verse csharp csharp-code csharp-library dotnet-core dropdown dropdown-menus library open-source open-source-community open-source-project opensource
Last synced: 7 months ago
JSON representation
A comprehensive library for querying bible content and getting cascading dropdowns for loading books of the bible, chapters and associated verses.
- Host: GitHub
- URL: https://github.com/ogubuikeAlex/BibleIndexer-v2
- Owner: ogubuikeAlex
- License: mit
- Created: 2023-03-04T17:25:45.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-07-22T21:05:04.000Z (almost 2 years ago)
- Last Synced: 2024-12-02T06:44:26.836Z (7 months ago)
- Topics: api, bible, bible-api, bible-study, bible-verse, csharp, csharp-code, csharp-library, dotnet-core, dropdown, dropdown-menus, library, open-source, open-source-community, open-source-project, opensource
- Language: C#
- Homepage: https://github.com/king-Alex-d-great/BibleIndexer
- Size: 1.35 MB
- Stars: 12
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: license.md
- Code of conduct: code_of_conduct.md
Awesome Lists containing this project
README
# Bible Indexer
A comprehensive library for querying bible content and getting cascading dropdowns for loading books of the bible, chapters and associated verses.
## Author
- [King Alex](https://github.com/king-Alex-d-great)
## **Badges**
[](https://choosealicense.com/licenses/mit/)
stable release version: 
Nuget package downloads: 
## 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:
```C#
NuGet\Install-Package BibleIndexer.Query -Version 1.1.1
```
Or from the .NET CLI as:
```C#
dotnet add package BibleIndexer.Query --version 1.1.1
```
Finally, import into the file:
```C#
using BibleIndexerV2;
```
## Doc Reference
### Get chapters in the Book Of a bible
- Sample Usage:
```C#
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` |
### Generate a random bible verse
- Sample Usage
```C#
await BibleService.GenerateRandomBibleVerse();
```
- Output
| Type |
| :------- |
| `Task` |
### Get all books of the bible
- Sample Usage
```C#
await BibleService.GetAllBooksOfTheBible();
```
- Output
| Type |
| :------- |
| `Task` |
### Get all verses and verses dropdown in a chapter of the bible
- Sample Usage
```C#
await BibleService.GetAllVersesInAChapterOFTheBible(request);
```
- Input
| Parameter | Type |
| :-------- | :------- |
| `request` | `GetBibleVerseRequest` |
- Output
| Type |
| :------- |
| `Task` |
### Get a book of the bible
- Sample Usage
```C#
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` |
### Get a bible verse
- Sample Usage
```C#
await BibleService.GetBibleVerse(request);
```
- Input
| Parameter | Type |
| :-------- | :------- |
| `request` | `GetBibleVerseRequest` |
- Output
| Type |
| :------- |
| `Task` |
### Search the bible
- Sample Usage
```C#
await BibleService.SearchBible(query);
```
- Input
| Parameter | Type | Description |
| :-------- | :------- | :------------------------- |
| `query` | `string` | **Required**. Query param for the search |
- Output
| Type |
| :------- |
| `Task>` |
## 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.md`.