/Faal-Hafez-GUI

Faal Hafez is a Java application that fetches and displays Faal Hafez, a form of Persian divination based on Hafez's poems.

Primary LanguageJava

Faal Hafez 📖 ✨

This Java application fetches and displays Faal Hafez (a form of Persian divination based on Hafez Shirazi's poems) using a REST API. The application is built with Java Swing for the GUI and uses Maven for dependency management.

homePage

Table of Contents 📌

Features 💡

  • Fetches Faal Hafez from a REST API
  • Beautiful and intuitive GUI
  • Displays the poem and its interpretation

faalPage

Code Structure 📁

The application is divided into several classes, each representing a different frame in the application:

  • Main: This is the main class that starts the application.
  • FaalGUI: This class represents the main GUI of the application.
  • Faal: This class represents the Faal Hafez object.

Installation 🔧

This project uses Maven for dependency management. To install and run the project, follow these steps:

  1. Clone the repository: git clone https://github.com/yourusername/yourrepository.git
  2. Navigate to the project directory: cd yourrepository
  3. Install the dependencies: mvn install
  4. Run the application: mvn exec:java -Dexec.mainClass="org.example.Main"

Future Improvements 🌟

  • Add a database to store user information and transaction history.
  • Implement features such as bookmarking favorite poems, sharing poems, etc.
  • Improve the GUI design and user experience.

Requirements 📋

  • Java Development Kit (JDK) 8 or above.
  • Maven for dependency management.

Contributing 🤝

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Contact 📧

For any questions, feel free to reach out to me at m3hdigholami@aut.ac.ir.

Enjoy using Faal Hafez! 🎉

I hope you find this Faal Hafez application useful and fun to use!