https://github.com/aamirbhat382/tajweed

Tajweed is npm package for parsing Tajweed and Buck
https://github.com/aamirbhat382/tajweed

buck javascript npm npm-package tajweed tajweed-parsing

Last synced: 4 days ago
JSON representation

Tajweed is npm package for parsing Tajweed and Buck

• Host: GitHub
• URL: https://github.com/aamirbhat382/tajweed
• Owner: aamirbhat382
• License: gpl-3.0
• Created: 2022-02-23T14:35:24.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-02-25T11:19:26.000Z (over 2 years ago)
• Last Synced: 2024-10-05T06:48:48.840Z (about 1 month ago)
• Topics: buck, javascript, npm, npm-package, tajweed, tajweed-parsing
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/tajweed
• Size: 19.5 KB
• Stars: 11
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Tajweed

*Tajweed is [npm](https://en.wikipedia.org/wiki/Npm_(software)) package for Tajweed and Buck*

## Quran Tools for Parsing Tajweed and Buck

The npm package is to be used with the [AlQuran.cloud](https://alquran.cloud/api) and [GlobalQuran.com](http://docs.globalquran.com/API:Data/Quran_List) APIs. They are made available so you may get the most out of the APIs.

## Installation

Use the package manager [npm](https://www.npmjs.com/) to install Tajweed.

```bash

npm install tajweed

#or

yarn add tajweed

```

## Usage

```javascript

const Tajweed = require('tajweed').Tajweed

let string = "۞ ٱللَّهُ نُورُ [h:9421[ٱ][l[ل]سَّمَ[n[ـٰ]و[n[َٲ]"; // 

let parseTajweed = new Tajweed()

let parseString = parseTajweed.parse("string",true)

console.log(parseString)

```

```javascript

import './tajweed.css'  

import tajweed, {Tajweed}  from 'tajweed';

function App() {

let string = "۞ ٱللَّهُ نُورُ [h:9421[ٱ][l[ل]سَّمَ[n[ـٰ]و[n[َٲ]"; // 

let parseTajweed = new Tajweed()

let parseString = parseTajweed.parse("string",true)

  return (

    


  );

}

export default App;

```

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

## License

[MIT](https://choosealicense.com/licenses/mit/)