A spiritual productivity app to help Muslims maximize their Ramadhan through daily ibadah tracking, goal-setting, prayer/iftar schedule, and daily Islamic insights.
Ramadhan Companion is a Progressive Web App (PWA) built with privacy and offline capabilities in mind. All your data stays on your device.
- Daily Checklist: Track your prayers, Quran recitation, and other acts of worship.
- Prayer Times & Iftar Countdown: Accurate prayer times based on your location, with a live countdown to Iftar.
- Goal Setting: Set personal goals for Ramadhan and track your progress.
- Daily Insights: Inspirational Hadith, Quran verses, and Dua specifically curated for Ramadhan.
- Zikr Counter: A digital Tasbih for your daily dhikr.
- Privacy First: 100% client-side storage. No account required, no tracking.
- Offline Capable: Works offline after the first load. Installable as an app on your phone or desktop.
- Frontend: React with TypeScript
- Build Tool: Vite
- Styling: Tailwind CSS
- State Management: Zustand
- Routing: React Router
- PWA: vite-plugin-pwa
- Animations: Framer Motion
- Date Handling: date-fns & date-fns-hijri
- Icons: Lucide React
-
Clone the repository:
git clone https://github.com/yourusername/ramadhan-companion.git cd ramadhan-companion -
Install dependencies:
npm install
-
Start the development server:
npm run dev
-
Open your browser and navigate to
http://localhost:5173.
To create a production build:
npm run buildTo preview the production build locally:
npm run previewContributions are welcome! Please read our CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests.
This project is licensed under the MIT License - see the LICENSE file for details.
- Aladhan API for prayer times data.
- The open-source community for the amazing tools and libraries used in this project.