📓 Muslim Learning Journal

A simple, offline CLI app to help Muslims track, reflect, and grow in their learning journey — especially Qur'an studies and other Islamic or personal development subjects.

---

🌟 About the Project

Muslim Learning Journal is a terminal-based personal progress tracker built with Python.
It allows you to log daily learning efforts like:

• 🕋 Qur'an Tafseer study
• 🎙️ Qur'an Tilawat (Recitation/Manzil)
• 📚 Other subjects (Islamic studies, Arabic, general knowledge, school material, etc.)

It is ideal for:

• Muslim students who want a daily study journal
• Parents who want to track their child's learning
• Teachers giving regular assignments
• Self-learners who want to build discipline

---

✨ Why Is It Beneficial?

Islam encourages self-accountability (Muhasabah) and consistency (Istiqamah) in all efforts.

This journal helps you:

• 🧠 Stay organized and aware of your learning progress
• 📆 Build a habit of daily Qur'an engagement, even if small
• 📊 Reflect on weekly activity and spot gaps
• 🛠️ Store learning logs permanently as .json and beautifully formatted .md files

You stay consistent. The journal keeps track.
No internet, no signup, just you and your learning.

---

🖥️ Features

✅ Track multiple types of entries
✅ Save and edit your progress
✅ See weekly time summaries
✅ Protect data with a password
✅ View or export your logs to Markdown
✅ Simple and interactive CLI menu
✅ Remembers your subjects and books — enter once, then just select from the list
✅ Fully offline — works on any Python 3 system \

---

🛠️ Features in the Pipeline

Planned improvements and upcoming features:

• 🔍 Search and filter: View entries by book or subject
• 📆 Monthly / yearly reports: Track long-term learning habits
• 🎯 Goals and streaks: Stay motivated with progress milestones
• 🕰️ Custom time units: Log by minutes, hours, pages, or ayahs
• 🌐 Language support: Urdu/Arabic localization options
• 🎒 Student mode: Assignments, grading, and feedback features for classroom use
• 📁 Backup and import/export: Easy file management
• 🪄 Graphical version: Basic GUI version (maybe via PyQt or Tkinter)

Got an idea? Feel free to suggest or contribute!

---

🧪 Demo

<><><>__( Muslim Learning Journal )__<><><>

1. Al-Qur'an (Tafseer)
2. Al-Qur'an (Tilawat)
3. Log Other Subjects
4. Save Progress
5. View Entries
6. Edit Entries
7. Delete Entries
8. Exit

📂 How to Use

1. Clone or Download the Repository

git clone https://github.com/Umair-Awans/Muslim-Learning-Journal.git
cd Muslim-Learning-Journal

2. Run the Application

If you have Python 3.7+ installed:

✅ Just double-click the main.py file
or
Run from terminal or command prompt:

python main.py

Make sure Python is properly installed and added to your system PATH.

3. Set a Password (only once)

You will be asked to set a password for data deletion protection.

4. Start Logging

   Choose from Tafseer, Tilawat, or Other subjects

   Input session details

   Save your progress regularly

🧾 Data Format

Your data is saved in:

data/Learning_Journal.json — long-term structured storage

data/Learning_Journal.md — readable summary of daily efforts

Each entry contains:

Book / Subject

Unit / Chapter

Time spent

Optional notes

Automatically recorded timestamps

📈 Weekly Summary

When you launch the journal, it displays a 7-day total of time spent on learning.

Example:

-------------( Weekly Report )------------- You spent a total of 3 hr(s) 45 min(s) on learning activities over the past week.

🔐 Password Protection

Deleting all records requires entering the correct password — an extra layer of safety.

✨ Customization Ideas

Add subject-specific fields for Arabic, Hadith, Fiqh, etc.

Add goals or streaks for motivation

Add monthly/yearly reports

Add search/filter to view entries by book or category

📚 Technologies Used

Python 3.7+ (tested on 3.7.4)

Built-in libraries: json, datetime, random, copy

✅ No external dependencies — runs in any Python environment!

🧰 Don't Have Python Installed?

You can run this project on any system with Python 3.7 or higher (3.8, 3.9, 3.10...).

➡️ Download Python if needed.

Once installed, either:

Run it from terminal with: python main.py, or

Double-click the main.py file directly (Windows only)

🪄 Not a programmer? A Windows .exe version is coming soon! No need to install Python — just download and click. Stay tuned via the Releases tab!

💖 Contribution

Feel free to fork this project and improve it further! New features, design improvements, or even simple bug fixes are welcome.

🧑‍💻 Author

Made with love for the Ummah by a self-taught developer.

"Even if it's a single ayah, keep going." 🌱

📄 License

This project is licensed under the MIT License.

---