Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📝 create a nice readme for project #2

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
110 changes: 108 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,108 @@
# Qurn
This repo stand for managing thing related to Quran App
# 📖 Quran Open Source App

A beautifully designed and feature-rich Quran application that brings the complete Quran experience to users worldwide. This open-source app is built with care to provide seamless access to the Holy Quran, with features to enhance the learning and recitation experience.

---

## 🌟 Features

- **Complete Quran**: Access the full Quran text with clear and crisp rendering.
- **Translations**: Multiple translations in various languages for better understanding.
- **Tafsir**: In-depth explanations and interpretations (Tafsir) for enhanced comprehension.
- **Audio Recitation**: Listen to your favorite reciters with adjustable playback speed.
- **Bookmarking**: Save your progress or favorite verses for easy access.
- **Search**: Quickly find specific verses or topics within the Quran.
- **Thematic Index**: Explore topics and themes within the Quran.
- **Dark Mode**: Switch between light and dark themes for a comfortable reading experience.

---

## 🚀 Getting Started

Follow these instructions to set up the project locally:

### Prerequisites

Make sure you have the following installed:
- [Node.js](https://nodejs.org/)
- [Git](https://git-scm.com/)

### Installation

1. **Clone the Repository**:
```bash
git clone https://github.com/your-username/quran-app.git
cd quran-app
```

2. **Install Dependencies**:
```bash
npm install
```

3. **Start the Development Server**:
```bash
npm start
```

4. **Access the App**:
Open your browser and navigate to `http://localhost:3000`.

---

## 🛠️ Technologies

- **Frontend**: [React](https://reactjs.org/) / [Next.js](https://nextjs.org/)
- **Backend**: [Node.js](https://nodejs.org/) / [Deno](https://deno.land/)
- **Styling**: [TailwindCSS](https://tailwindcss.com/)
- **Database**: [MongoDB](https://www.mongodb.com/) or [PostgreSQL](https://www.postgresql.org/)

---

## 📄 Roadmap

We welcome contributions to make this app even better. Here are a few planned features:
- **Advanced Search with Filters**
- **Customizable Audio Looping**
- **Qibla Direction Finder**
- **Daily Verse Notifications**

---

## 🤝 Contributing

We welcome contributions from the community!

1. Fork the repository
2. Create a new branch: `git checkout -b feature/your-feature`
3. Commit your changes: `git commit -m 'Add some feature'`
4. Push the branch: `git push origin feature/your-feature`
5. Submit a pull request

---

## 💬 Community

Join the discussion and get updates:
- [Issues](https://github.com/your-username/quran-app/issues)
- [Discussions](https://github.com/your-username/quran-app/discussions)

---

## 🕌 Acknowledgements

Special thanks to:
- The Quran Open Source Community
- Developers and designers contributing to Islamic apps

---

## 📜 License

This project is licensed under the [MIT License](LICENSE).

Feel free to use, distribute, and modify the code with attribution.

---

**Built with ❤️ for a better Quran learning experience.**