Skip to content

Balagha/dhikr

Repository files navigation

بِسْمِ اللَّهِ الرَّحْمَنِ الرَّحِيم

Dhikr Browser Extension

فَٱذْكُرُونِىٓ أَذْكُرْكُمْ وَٱشْكُرُواْ لِى وَلَا تَكْفُرُونِ
So remember Me and I shall remember you; give thanks to Me and do not be ungrateful to Me for My favours. (2:152)

Overview

Dhikr is a cross-browser extension that brings a touch of spiritual enrichment to your daily browsing experience. With Dhikr, every new tab becomes an opportunity to read a Hadith and learn a new word, fostering a sense of mindfulness and knowledge.

Hadith

Arabic Quiz

Features

  • Hadith: Each time you open a new tab, Dhikr presents you with a carefully selected Hadith to inspire and guide you.

  • Learn a New Word: Expand your vocabulary by discovering a new word with its definition every time you open a new tab.

  • Cross Browser Support: Dhikr is available for both Chrome and Firefox browsers, ensuring accessibility for a wider audience.

Installation

Chrome

  • Visit the Chrome Web Store.
  • Click on "Add to Chrome" to install the extension.
  • Dhikr is now ready to enrich your browsing experience.

Firefox

  • Visit the Firefox Add-ons.
  • Click on "Add to Firefox" to install the extension.
  • Dhikr is now ready to enhance your Firefox browsing.

Development

To set up the development environment for Dhikr, follow these steps:

  1. Clone the repository:
git clone https://github.com/Balagha/dhikr.git
  1. Install dependencies:
cd dhikr
npm install
  1. Create a .env file in the root directory and set the necessary environment variables.

  2. Start the development server:

npm start

Build

To build Dhikr for Chrome or Firefox, use the following commands:

Chrome

npm run build:chrome

Firefox

npm run build:firefox

These commands will generate the necessary build files in the build directory.

Contributing

We welcome contributions from the community. If you find any issues or have ideas for improvements, please open an issue or submit a pull request.

License

This project is licensed under the Apache License.