https://github.com/quran/api-js

Quran.com's API Javascript SDK https://npmjs.com/package/@quranjs/api
https://github.com/quran/api-js

javascript quran quran-api-client quranjs

Last synced: about 1 month ago
JSON representation

Quran.com's API Javascript SDK https://npmjs.com/package/@quranjs/api

• Host: GitHub
• URL: https://github.com/quran/api-js
• Owner: quran
• License: mit
• Created: 2022-03-28T14:29:28.000Z (over 2 years ago)
• Default Branch: dev
• Last Pushed: 2023-12-30T08:53:10.000Z (12 months ago)
• Last Synced: 2024-04-13T16:07:14.170Z (8 months ago)
• Topics: javascript, quran, quran-api-client, quranjs
• Language: TypeScript
• Homepage: https://quranjs.com
• Size: 863 KB
• Stars: 28
• Watchers: 3
• Forks: 3
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Quranjs Api Header](https://github.com/quran/api-js/raw/master/media/repo-header.png)

A library for fetching quran data from the [quran.com API][qdc-api]. This library also works on both Node.js and the browser.

[Checkout Docs][docs]

[![Build Status][build-badge]][build]

[![MIT License][license-badge]][license]

[![NPM Version][npm-badge]][npm]

[![Minziped Size][size-badge]][npm]

[![NPM Monthly downloads][downloads-badge]][npm]

## Installation

using npm:

```ssh

npm install @quranjs/api

```

using yarn:

```ssh

yarn add @quranjs/api

```

## Getting Started

you can visit the [docs][docs] for more details.

[qdc-api]: https://quran.api-docs.io/

[docs]: https://quranjs.vercel.app/

[build-badge]: https://github.com/quran/api-js/workflows/CI/badge.svg

[build]: https://github.com/quran/api-js/actions?query=workflow%3ACI

[license-badge]: https://badgen.net/github/license/quranjs/api

[license]: https://github.com/quran/api-js/blob/master/LICENSE

[npm]: https://www.npmjs.com/package/@quranjs/api

[npm-badge]: https://badgen.net/npm/v/@quranjs/api

[downloads-badge]: https://img.shields.io/npm/dm/@quranjs/api.svg

[size-badge]: https://badgen.net/packagephobia/publish/@quranjs/api