Skip to content

Abdelkaderbzz/ramadan-tracker

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

135 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Ramadan Tracker πŸŒ™

CI License: MIT PRs Welcome Buy Me A Coffee

A progressive web app that helps Muslims stay on track during Ramadan β€” monitor your prayers, duas, Quran recitation, and daily worship with insightful progress tracking throughout the blessed month.

✨ Features

πŸ•Œ Prayer Times

  • Live prayer times fetched from the Aladhan API using the MWL (Muslim World League) calculation method
  • Auto-detects user location via Geolocation API (falls back to Mecca)
  • Highlights the next upcoming prayer

πŸ“– Quran Tracker

  • Track surahs and juz' you have read
  • Visual progress bar for your Quran completion journey

🀲 Dua & Dhikr

  • Log morning and evening adhkar completion
  • Browse a curated dua collection
  • Save and manage your personal duas

πŸ“Š Dashboard & Progress

  • Daily tracking table for fasting, prayers, Quran, charity, and more
  • Worship statistics with visual charts
  • Daily motivation quotes to keep you inspired

πŸ“… Islamic Calendar

  • Integrated Hijri calendar with RTL support
  • Ramadan day counter

πŸ† Achievements

  • Earn badges for consistent worship and milestones

πŸ“ Ramadan Journey

  • Set and track personal Ramadan goals
  • Daily journal for reflections and memories

🌍 Multilingual

  • Full support for Arabic (RTL), English, and French
  • Language switcher built into the UI

πŸ“± PWA Support

  • Installable on mobile and desktop as a Progressive Web App
  • Offline-capable with service worker caching

πŸš€ Getting Started

Prerequisites

  • Bun v1.0+ runtime installed

Installation

  1. Clone the repository:

    git clone https://github.com/Abdelkaderbzz/ramadan-tracker.git
  2. Navigate to the project folder:

    cd ramadan-tracker
  3. Install dependencies:

    bun install
  4. Start the development server:

    bun run dev
  5. Open http://localhost:3000 in your browser.

πŸ›  Tech Stack

Category Technology
Framework Next.js 14 (App Router)
Runtime Bun
Language TypeScript
Styling Tailwind CSS
UI Components Radix UI + shadcn/ui
State Zustand
Animations Framer Motion
i18n next-intl
Forms React Hook Form + Zod
Charts Recharts
Theming next-themes
PWA @ducanh2912/next-pwa
Prayer Times Aladhan API (MWL method)

πŸ“ Project Structure

ramadan-tracker/
β”œβ”€β”€ app/
β”‚   └── [locale]/            # Locale-based routing (en, fr, ar)
β”‚       β”œβ”€β”€ layout.tsx
β”‚       └── page.tsx
β”œβ”€β”€ components/
β”‚   β”œβ”€β”€ features/
β”‚   β”‚   β”œβ”€β”€ achievements/    # Badge system
β”‚   β”‚   β”œβ”€β”€ calendar/        # Islamic/Hijri calendar
β”‚   β”‚   β”œβ”€β”€ dashboard/       # Stats, daily tracking table
β”‚   β”‚   β”œβ”€β”€ journey/         # Goals, journal, motivation
β”‚   β”‚   β”œβ”€β”€ prayer/          # Prayer times, duas, dhikr
β”‚   β”‚   └── quran/           # Quran surah/juz tracker
β”‚   β”œβ”€β”€ layout/              # Header, main layout
β”‚   └── ui/                  # shadcn/ui primitives
β”œβ”€β”€ hooks/                   # Custom React hooks
β”œβ”€β”€ i18n/                    # next-intl configuration
β”œβ”€β”€ lib/
β”‚   β”œβ”€β”€ constants/           # Duas, motivations
β”‚   β”œβ”€β”€ store/               # Zustand store & types
β”‚   β”œβ”€β”€ date-utils.ts        # Hijri date helpers
β”‚   └── quran-data.ts        # Surah & Juz metadata
β”œβ”€β”€ messages/                # Translation files (en, fr, ar)
β”œβ”€β”€ public/                  # Static assets, PWA manifest
└── styles/                  # Global CSS

πŸ“ Scripts

Command Description
bun run dev Start the development server
bun run build Build for production
bun run start Start the production server
bun run lint Run ESLint
bun run type-check Run TypeScript type checking

🀝 Contributing

Contributions are welcome! Please read our Contributing Guide for details on the development workflow and how to submit pull requests.

πŸ“„ License

This project is licensed under the MIT License β€” see the LICENSE file for details.

πŸ‘€ Author

abdelkaderbzz

β˜• Support

If you find this project useful and want to support its development, you can buy me a coffee!

Buy Me A Coffee

⭐ Show Your Support

Give a ⭐ if this project helped you during Ramadan!

About

A Ramadan tracking website that helps users monitor their prayers, duas, and Quran recitation, providing insights into their progress throughout the month.

Topics

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Sponsor this project

Packages

 
 
 

Contributors