An open API service indexing awesome lists of open source software.

https://github.com/sozenka/randomhadithgenerator

RandomHadithGenerator is a Java app that shares wisdom from Islam by displaying random Hadiths. It aims to inspire learning and reflection in the spirit of Islamic teachings.
https://github.com/sozenka/randomhadithgenerator

hadith intellij islam islamic java muslim

Last synced: 4 months ago
JSON representation

RandomHadithGenerator is a Java app that shares wisdom from Islam by displaying random Hadiths. It aims to inspire learning and reflection in the spirit of Islamic teachings.

Awesome Lists containing this project

README

          

```markdown
# RandomHadithGenerator

Assalamu Alaikum (Peace be upon you),

The `RandomHadithGenerator` is a Java application that brings to light the profound teachings of Islam through the sayings of Prophet Muhammad (PBUH). It randomly presents Hadiths from five of the most revered collections in Islam, offering users a pathway to explore Islamic teachings in a unique and enriching way.

## Features

- **Random Hadith Generation:** Discover new teachings and insights with randomly generated Hadiths.
- **Comprehensive Collections:** Includes Hadiths from Bukhari, Muslim, Abu Dawud, Tirmidhi, and Ibn Majah.
- **Java-Based Application:** Ensures wide compatibility and ease of use across different platforms.

## Getting Started

### Prerequisites

- Java Development Kit (JDK) - Make sure you have Java installed on your system.

### Installation

1. Clone the repository:
```bash
git clone https://github.com/sozenka/RandomHadithGenerator
```
2. Navigate to the project directory:
```bash
cd RandomHadithGenerator
```
3. Compile the Java files (ensure your JDK path is set):
```bash
javac src/*.java -d out
```
4. Run the application:
```bash
java -cp out Main
```

## Usage

Upon running the application, it will randomly select and display a Hadith from the included collections. The application is designed for simplicity, providing a straightforward interface for users to engage with the teachings of Islam.

## Contributing

In the spirit of brotherhood and sisterhood that Islam teaches us, we warmly welcome contributions. Your efforts to improve this project or to enrich it with new features are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

## License

Distributed under the MIT License. See `LICENSE` for more information.

## Contact
Should you have any inquiries or wish to contribute further, please reach out with the warmth and respect that our faith teaches us:

Instagram - [@sozenka](https://www.instagram.com/sozenka/)

Project Link: [https://github.com/sozenka/RandomHadithGenerator](https://github.com/sozenka/RandomHadithGenerator)

May Allah (SWT) put barakah in this project, and may it serve as a beneficial knowledge source for all. Ameen.