Giter Club home page Giter Club logo

havyaka-rest-api's Introduction

Havyaka The Rest API

This REST API provides information about Hindu Mantras and Suktam. It includes endpoints to retrieve mantras by name or range.

Installation and Run locally

clone

git clone https://github.com/gaonkarBhai/Havyaka-Rest-API.git
cd Havyaka-Rest-API

run with npm

  npm i
  npm start

On port localhost:8000/

Environment Variables

To run this project, you will need to add the MONGODB_URI environment variables to your .env file

Authentication/Authorization

No authentication or authorization is required to access this API.

End Points & Query

mantraAPI

Query Parameter Description
limit Limits the number of results returned. Default: 5
sort Specifies the sorting order of the results. Comma-separated list of fields. Default: sorted by "number" field
fields Specifies the fields to include in the returned results. Comma-separated list of fields
range Filters results by the "range" field
name Performs a case-insensitive search for the provided string value in the "name" field

Demo

Request

https://havyaka-rest-api-gaonkarbhai.vercel.app/api/v1/mantras?limit=1

Responce

    {
  "mantras": [
    {
      "_id": "64897f6fd17f7175cd6a57c8",
      "number": 1,
      "name": "Gayatri Mantra",
      "shloka": "Om Bhur Bhuva Swaha, Tat Savitur Varenyam Bhargo Devasya Dheemahi, Dhiyo Yo Nah Prachodayat",
      "range": "long",
      "godName": "The Sun God (Savitur)",
      "purpose": "The Gayatri Mantra is a sacred Vedic chant that is dedicated to the Sun God and is believed to bestow wisdom, enlightenment, and divine grace.",
      "duration": "Repetition 108 times",
      "origin": "Rigveda",
      "chantingInstructions": "Sit in a calm and quiet place, focus your attention on the divine qualities of the Sun God, and chant the mantra with sincerity and devotion. Repeat it 108 times using a mala (prayer beads) if possible.",
      "benefits": "Enhances spiritual growth, promotes intellectual sharpness, brings clarity of thought, and bestows divine blessings.",
      "culturalSignificance": "The Gayatri Mantra holds immense cultural and spiritual significance in Hinduism and is considered one of the most important and powerful mantras.",
      "references": [
        {
          "title": "Rigveda",
          "link": "https://www.sacred-texts.com/hin/rigveda/",
          "_id": "64897f6fd17f7175cd6a57c9"
        },
        {
          "title": "Yajurveda",
          "link": "https://www.sacred-texts.com/hin/yv/",
          "_id": "64897f6fd17f7175cd6a57ca"
        }
      ],
      "__v": 0
    }
  ],
  "docNum": 1,
  "success": true

}

Author - About Me

github

Linkedin

  • @Naveen

  • If you find any odd or mismatch please contact Me

havyaka-rest-api's People

Contributors

gaonkarbhai 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.