Tzakkar

Tzakkar is a web extension designed to gently remind Muslims to seek Allah's forgiveness throughout the day. Lightweight, fast, and privacy-focused, Tzakkar offers a simple way to stay mindful and connected to your faith while browsing.

Acknowledgements

A special acknowledgment goes to Rana Abdelsalam (Software Engineer), the co-author of Tzakkar, whose expertise and dedication were vital to the development of this extension. Her contributions have significantly shaped Tzakkar to be the effective tool it is today. May Allah grant her Paradise and make her work on this project a part of her good deed.

Features

• 🌟 Get Closer to Allah: Provides regular reminders to ask for Allah's forgiveness.
• ⚡ Lightweight and Fast: Designed for efficiency and speed.
• 🧩 User-Friendly: Simple and intuitive interface.
• 🔒 Privacy-Focused: No data collection; all settings are stored locally.

Installation

Stable Release

• From Chrome Web Store: Available Soon.
• From Microsoft Edge Add-ons: Available Soon.

Development Release

To install the development version, follow these steps:

1. Clone the Repository:

   git clone https://github.com/MohamedAAbdallah/Tzakkar.git

2. Turn on Developer Mode:

   • Go to the Chrome or Edge extensions page (chrome://extensions/ or edge://extensions/).
   • Enable "Developer Mode" (usually found in the top right corner).

3. Install Unpacked Extension:

   • Click on "Load unpacked" and select the cloned repository's folder.

Now, you can start using Tzakkar in its development form.

Usage

After installation, Tzakkar will display a small popup with a message in the bottom right corner of your browser. The extension operates on all pages but does not access or modify any website data.

Contributing

We welcome all contributions to Tzakkar! Here’s how you can help:

1. Fork the Repository: Create a fork of the repository to your GitHub account.
2. Create a Branch: Make a new branch with a descriptive name (e.g., feature/your-feature-name).
3. Commit Your Changes: Write clear, concise, and well-documented code.
4. Submit a Pull Request: Open a Pull Request with a clear description of your changes.

Please read our Contributing Guidelines and adhere to our Code of Conduct.

Code of Conduct

We are committed to providing a welcoming and inclusive environment for everyone. All participants are expected to follow the Code of Conduct.

To report any violations, please create a GitHub issue or contact us via email at eng.mohamed.a.abdallah@gmail.com.

License

This project is licensed under the GNU General Public License v3.0 (GPL-3.0). You are free to use, modify, and distribute the software, provided that you comply with the terms of this license.

For more information, see the full GNU General Public License v3.0.

Contact

For any questions, suggestions, or issues, please feel free to reach out:

• Author: Mohamed A. Abdallah
• Email: eng.mohamed.a.abdallah@gmail.com
• GitHub: MohamedAAbdallah

Thank you for supporting Tzakkar!

---