Skip to content
MagicMirror module to display Quran Ayah/Verse randomly
JavaScript CSS
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
js initial release Feb 18, 2017
refs initial release Feb 18, 2017
translations add telegram support Nov 11, 2017
.gitattributes :neckbeard: Added .gitattributes & .gitignore files Feb 18, 2017
.gitignore add screenshot Mar 13, 2017
LICENSE update author in license Feb 19, 2017
MMM-RandomQuranAyah.css add CSS for arabic and translation Feb 12, 2019
MMM-RandomQuranAyah.js add CSS for arabic and translation Feb 12, 2019
README.md update installation info Apr 9, 2018
node_helper.js
screenshot.png initial release Feb 18, 2017

README.md

MMM-RandomQuranAyah

This an extension for the MagicMirror. It will display Quran's ayah (verse) randomly from http://api.alquran.cloud. You can display whether arabic, translation, or both. All translation options can be found at http://api.alquran.cloud/edition.

Version

1.1

  • get and display current displayed Qur'an ayah/verse in telegram (requires MMM-TelegramBot) by typing command /quranverse

1.0

  • initial release

Screenshot

Screenshot

Installation

  1. Navigate into your MagicMirror's modules folder
  2. execute git clone https://github.com/slametps/MMM-RandomQuranAyah.git
  3. if this module does not run correctlt, try npm install async

Using the module

To use this module, add it to the modules array in the config/config.js file:

modules: [
	{
		module: 'MMM-RandomQuranAyah',
		position: 'top_bar',	// This can be any of the regions. Best result is in the top_bar/bottom_bar as ayah (verse) can take multiple lines.
		config: {
			apiVersion: '1.0', // please, leave unchanged. reserved for future use.
			showArabic: true,
			showTranslation: true,
			surahArabicName:false,
			translationLang:'id.indonesian',
			updateInterval: 3600 * 1000, // milliseconds
		}
	}
]

Configuration options

The following properties can be configured:

Option Description
apiVersion 1.0 (reserved for future use)
showArabic display arabic?
Possible values:true/false
Default value: true
showTranslation display translation?
Possible values:true/false
Default value: true
surahArabicName display Surah name in Arabic?
Possible values:true/false
Default value: false
translationLang List of the supported translation: http://api.alquran.cloud/edition
Default value: en.yusufali
updateInterval How ofter to get new ayah/verse? (milliseconds)
Default value: 600000 (10 minutes)
animationSpeed Speed of the update animation. (Milliseconds)

Possible values:0 - 5000
Default value: 2500 (2.5 seconds)

Dependencies

The MIT License (MIT)

Copyright © 2016-2017 Arthur Garza

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

The software is provided “as is”, without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the software.

You can’t perform that action at this time.