Skip to content

Create an app for the Bhagavad Gita by integrating a free API to fetch verses and related content. Utilize Hilt-Dagger for dependency injection and Room databaseand retrieved data within the app.

Notifications You must be signed in to change notification settings

AakashPatil1/Bhagavad-Gita

Repository files navigation

Bhagavad-Gita

Create an app for the Bhagavad Gita by integrating a free API to fetch verses and related content. Utilize Room database to allow users to personalize their experience by storing preferences like language selection, favorite verses, and retrieved data within the app.

Overview

The Bhagavad Gita App is a mobile application that provides access to the timeless wisdom of the Bhagavad Gita, a sacred Hindu scripture. The app fetches Bhagavad Gita verses and related content using the Bhagavad Gita API and allows users to customize their experience.

Features

  • Retrieve Bhagavad Gita verses and translations using the Bhagavad Gita API.
  • Save and manage data using Room database.
  • Display verses and translations from the Room database, minimizing redundant API calls.
  • Dependency injection with Hilt-Dagger for better code organization.

Usage

  1. Sign up on RapidAPI and obtain your API key from Bhagavad Gita API on RapidAPI.

  2. Add your API key to the HTTP request headers when making API calls using the following code:

    Request authenticatedRequest = originalRequest.newBuilder()
            .addHeader("X-RapidAPI-Key", "**Enter your API key**")
            .addHeader("X-RapidAPI-Host", "bhagavad-gita3.p.rapidapi.com")
            .build();

    Replace "Enter your API key" with the API key you obtained from RapidAPI.

  3. Run the app on a mobile device or emulator.

  4. Explore Bhagavad Gita verses, translations, and customize the app's settings based on your preferences. The app will use the data saved in the Room database , minimizing API calls.

Installation

To run the app locally, follow these steps:

  1. Ensure you have the necessary development environment set up, including Android Studio and an Android emulator or a physical Android device.

  2. Clone the repository using the following command:

    git clone https://github.com/your_username/bhagavad-gita-app.git
  3. Open the project in Android Studio.

  4. Build and run the app on your emulator or device.

Dependencies

Make sure to add the following dependencies to your build.gradle file:

dependencies {
    implementation "androidx.room:room-runtime:2.4.2"
    kapt "androidx.room:room-compiler:2.4.2"
    implementation "com.google.dagger:hilt-android:2.40.5"
    kapt "com.google.dagger:hilt-compiler:2.40.5"
    // other dependencies...
}

Contributing

Contributions are welcome! If you'd like to contribute to the project, please follow the Contributing Guidelines.

License

This project is licensed under the MIT License.