https://github.com/adelpro/open-quran

An open-source Quran application designed to provide an optimal quran audio streaming experience across various platforms, using of WebTorrent allows for decentralized storage of Quran audio content, eliminating the need for a central server.
https://github.com/adelpro/open-quran

jotai magnet nextjs quran streaming torrent webtorrent

Last synced: 7 months ago
JSON representation

An open-source Quran application designed to provide an optimal quran audio streaming experience across various platforms, using of WebTorrent allows for decentralized storage of Quran audio content, eliminating the need for a central server.

• Host: GitHub
• URL: https://github.com/adelpro/open-quran
• Owner: adelpro
• License: mit
• Created: 2025-01-20T09:16:08.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2025-03-02T10:22:55.000Z (7 months ago)
• Last Synced: 2025-03-02T10:24:25.721Z (7 months ago)
• Topics: jotai, magnet, nextjs, quran, streaming, torrent, webtorrent
• Language: TypeScript
• Homepage: https://www.openquran.us.kg
• Size: 1.72 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
# Open Mushaf

![GitHub Stars](https://img.shields.io/github/stars/adelpro/open-quran?style=social)

![Forks](https://img.shields.io/github/forks/adelpro/open-quran?style=social)

[![Twitter Follow](https://img.shields.io/twitter/follow/adelpro?style=social)](https://twitter.com/adelpro)

![Next.JS](https://img.shields.io/badge/Next.js-3178C6?logo=next.js&logoColor=fff&style=flat)

![PWA](https://img.shields.io/badge/PWA-1B1F23?logo=pwa&logoColor=fff&style=flat)

![WebTorrent](https://img.shields.io/badge/WebTorrent-20232A?style=flat)

![Jotai](https://img.shields.io/badge/Jotai-20232A?style=flat)

[![Codacy Badge](https://app.codacy.com/project/badge/Grade/270e870a48f342ef9ba384229681db23)](https://app.codacy.com/gh/adelpro/open-quran/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)

![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https://github.com/adelpro/open-quran&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=hits&edge_flat=false)

Open Quran is an open-source Quran application designed to provide an optimal quran audio streaming experience across various platforms. Built with modern web technologies, it ensures performance and responsive design. The use of WebTorrent also allows for decentralized storage of Quran audio content, eliminating the need for a central server and ensuring that the content is highly available.

## Features

- **Responsive Design**: Ensures a seamless experience across devices of all sizes.

- **Decentralized Storage**: Utilizes WebTorrent for efficient and secure storage of Quran content.

- **Offline Access**: As a Progressive Web App (PWA), it allows users to access the Quran even without an internet connection.

- **Tailwind CSS Styling**: Utilizes Tailwind CSS for efficient and customizable styling.

## Technologies Used

- **Next.js**: For server-side rendering and optimized performance.

- **TypeScript**: Ensuring type safety and a better developer experience.

- **Tailwind CSS**: For utility-first CSS styling.

- **Jotai**: For state management and global state.

- **Webtorrent**: For downloading and streaming Quran content.

- **PWA**: Provides offline capabilities and an app-like experience.

## Installation

1. **Clone the Repository**:

   ```bash

   git clone https://github.com/adelpro/open-quran.git

   cd open-quran

   ```

2. **Install Dependencies**:

   ```bash

   npm install

   ```

3. **Run the App**:

   ```bash

   npm run dev

   ```

## Contributing

We welcome contributions from the community. Please follow the [Contributing Guidelines](https://github.com/adelpro/open-quran/blob/main/CONTRIBUTING.md).

## License

This project is licensed under the [MIT License](https://choosealicense.com/licenses/mit/)

## Acknowledgments

- [Next.js](https://nextjs.org/)

- [Tailwind CSS](https://tailwindcss.com/)

- [Webtorrent](https://webtorrent.io/)

- [Jotai](https://jotai.org/)

## Contact

For any inquiries or suggestions, please contact [contact@openquran.us.kg](mailto:contact@openquran.us.kg)