Skip to content

mohamedfo17/Prayer-Time

Repository files navigation

Prayer-Time

🚀 Overview

Prayer-Time is a Next.js application designed to help users determine the prayer times for their location. This project leverages modern JavaScript frameworks and libraries to provide a seamless and responsive user experience. Whether you're a developer looking to contribute or a user seeking a reliable prayer time calculator, this project is for you.

✨ Features

  • 🕒 Accurate prayer time calculations based on your location
  • 🌍 Global support for various prayer times
  • 📱 Responsive design for mobile and desktop use
  • 🔒 Secure and private data handling
  • 🔧 Easy to customize and extend

🛠️ Tech Stack

  • Programming Language: JavaScript
  • Frameworks: Next.js, React
  • Libraries: Tailwind CSS, ESLint
  • Tools: Netlify, GitHub Actions
  • System Requirements: Node.js (v16 or later), npm (v6 or later)

📦 Installation

Prerequisites

  • Node.js (v16 or later)
  • npm (v6 or later)

Quick Start

# Clone the repository
git clone https://github.com/yourusername/prayer-time.git

# Navigate to the project directory
cd prayer-time

# Install dependencies
npm install

# Start the development server
npm run dev

Alternative Installation Methods

  • Using Yarn:
    yarn install
    yarn dev
  • Using Docker:
    docker-compose up

🎯 Usage

📁 Project Structure

prayer-time/
├── app/
│   ├── globals.css
│   ├── layout.js
│   ├── page.js
│   └── ...
├── public/
│   ├── file.svg
│   ├── globe.svg
│   ├── next.svg
│   ├── vercel.svg
│   └── ...
├── .gitignore
├── jsconfig.json
├── package.json
├── package-lock.json
└── README.md

🔧 Configuration

  • Configuration Files:
    • tailwind.config.js for Tailwind CSS customization

🤝 Contributing

  • How to Contribute:

    • Fork the repository
    • Create a new branch (git checkout -b feature/your-feature)
    • Commit your changes (git commit -am 'Add some feature')
    • Push to the branch (git push origin feature/your-feature)
    • Create a new Pull Request
  • Development Setup:

    • Clone the repository
    • Install dependencies (npm install or yarn install)
    • Start the development server (npm run dev or yarn dev)
  • Code Style Guidelines:

    • Follow the ESLint configuration
    • Use consistent naming conventions
  • Pull Request Process:

    • Ensure your code is well-tested
    • Provide clear and concise commit messages
    • Address any feedback from reviewers

🗺️ Roadmap

  • Planned Features:
    • Add support for more prayer methods
    • Implement user authentication
    • Improve UI/UX design
  • Known Issues:
    • Fajr Prayer Time from Api
  • Future Improvements:
    • Integrate with more calendar systems
    • Add multi-language support

Additional Guidelines:

  • Use modern markdown features (badges, collapsible sections, etc.)
  • Include practical, working code examples
  • Make it visually appealing with appropriate emojis
  • Ensure all code snippets are syntactically correct for JavaScript
  • Include relevant badges (build status, version, license, etc.)
  • Make installation instructions copy-pasteable
  • Focus on clarity and developer experience

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published