Student Journey

A simple app to help beginner students of knowledge navigate the journey of learning Islam.

🌟 Features

• Progressive Web App (PWA) with offline support
• Dark/Light theme support
• Responsive design for all devices
• Interactive course navigation
• YouTube playlist integration
• Level-based learning paths (Basic, Intermediate, Advanced)

🛠️ Tech Stack

• React 18
• Vite
• Bootstrap 5
• Framer Motion
• React Responsive Modal
• React Icons
• Service Workers for PWA

🚀 Getting Started

1. Clone the repository:

git clone https://github.com/QayyimahLearning/QayyimahLearning.github.io.git

2. Install dependencies:

npm install

3. Run development server:

npm run dev

4. Build for production:

npm run build

📱 PWA Installation

• On desktop: Click the install button in your browser's address bar
• On iOS: Tap the share button and select "Add to Home Screen"
• On Android: Tap the "Add to Home Screen" prompt or use browser menu

🔧 Development

• npm run dev - Start development server
• npm run build - Build for production
• npm run preview - Preview production build
• npm run lint - Run ESLint
• npm run deploy - Deploy to GitHub Pages

Environment Setup

1. Create a .env file in the project root:

cp .env.example .env

2. Update the Firebase configuration variables in .env:

VITE_FIREBASE_API_KEY=your_api_key
VITE_FIREBASE_AUTH_DOMAIN=your_auth_domain
VITE_FIREBASE_PROJECT_ID=your_project_id
VITE_FIREBASE_STORAGE_BUCKET=your_storage_bucket
VITE_FIREBASE_MESSAGING_SENDER_ID=your_messaging_sender_id
VITE_FIREBASE_APP_ID=your_app_id
VITE_FIREBASE_MEASUREMENT_ID=your_measurement_id

3. Get these values from:

• Firebase Console
• Firebase Cloud Messaging

🌐 Browser Support

• Chrome (latest)
• Firefox (latest)
• Safari (latest)
• Edge (latest)

🤝 Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

---

May Allah guide us all to the truth and grant us the ability to understand and implement it in our daily lives.