README.md

Bhagavad Gita Explorer

Explore the timeless wisdom of the Bhagavad Gita with in-depth shlokas, translations, and commentaries, connecting you to India's rich spiritual heritage.

Github Stats

🌟 Stars	🍴 Forks	🐛 Issues	📏 Repo Size	🔔 Open PRs	🔕 Close PRs

Data source

• Data For This Project is Get From https://github.com/vedicscriptures/bhagavad-gita-data this repository.
• Just Download this Data in your computer and Put It Inside /Data/bhagavad-gita-data this Folder.
• Special Thanx to - PtPrashantTripathi

API Reference

Bhagavad Gita API

  https://bhagavadgitaapi.in/

Parameter	Type	Description
GET /slok	FREE	FREE To Use.
GET /slok/:ch/:sl	FREE	FREE To Use.
GET /chapters	FREE	FREE To Use.
GET /chapter/:ch	FREE	FREE To Use.

• But API linking is not Required in localHost, If you follow Installation Process.

• API Linked Repo - https://github.com/vedicscriptures/vedicscriptures.github.io

How To Build

Prerequisites Ensure you have the following software installed on your computer:

• Node.js
• npm
• Git
• Code Editor

Installation

Backend: Starting NodeJS Server

• Download the data from data source as above suggested and place it in the /Data/bhagavad-gita-data directory as mentioned above.

• Open a terminal and navigate to the Backend directory:

  cd Backend

• Install the necessary dependencies:

  npm i

• Start the NodeJS server:

  node index.js

Deployment

Frontend: Starting ReactJS

• Open a terminal and navigate to the Frontend directory:

  cd Frontend

• Install the necessary dependencies

  npm i

• Start the ReactJS development server:

  npm start

Usage

Once both the backend and frontend servers are running, you can access the application in your web browser at http://localhost:3000. Use the interface to browse, search, and read the shlokas along with their translations and commentaries.

Contributing

Contributions are always welcome!

• Fork the repository and Star it.
• Create a new branch:
• For each and every change create new branch with respective number.
• Make your changes and commit on the pull request.
• Push to the branch

  git push origin feature/YourFeatureName

• Open a pull request.

Running Tests

To run tests, run the following command

  https://vedic-sadhana.vercel.app/

Feedback

If you have any feedback, please reach out to us at Mail

Show Some Love by Starring the repo and Share this product!