https://github.com/jeninsutradhar/simplewikibrowserjava

A JavaFX-based Wikipedia browser application
https://github.com/jeninsutradhar/simplewikibrowserjava

browsers java javafx javafx-application javafx-desktop-apps wikipedia wikipedia-api

Last synced: 3 days ago
JSON representation

A JavaFX-based Wikipedia browser application

• Host: GitHub
• URL: https://github.com/jeninsutradhar/simplewikibrowserjava
• Owner: JeninSutradhar
• Created: 2024-05-02T14:53:58.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-12-29T18:32:45.000Z (4 days ago)
• Last Synced: 2024-12-29T19:21:45.656Z (4 days ago)
• Topics: browsers, java, javafx, javafx-application, javafx-desktop-apps, wikipedia, wikipedia-api
• Language: Java
• Homepage:
• Size: 20.5 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# JavaFX Wiki Browser

A simple JavaFX-based Wikipedia browser application. This application allows users to search for Wikipedia articles directly from a simple user interface.

![image](https://github.com/user-attachments/assets/adb89b8c-8f3a-46b4-a3c1-e6040c7f4acd)

## Prerequisites

Before you can run the application, you need to ensure you have the following installed:

*   **Java Development Kit (JDK):** You need Java 8 or higher. You can download from [Oracle](https://www.oracle.com/java/technologies/downloads/). You may also be able to use an OpenJDK distribution (e.g. [Adoptium](https://adoptium.net/)).

*   **Apache Maven:** This project uses Maven to manage dependencies and build process. Download and install it from [Apache Maven](https://maven.apache.org/).

## How to Run

Here are the steps to get the application up and running:

1.  **Clone the repository:**

    ```bash

    git clone [](https://github.com/JeninSutradhar/SimpleWikiBrowserJava)

    cd SimpleWikiBrowser

    ```

    Replace `[](https://github.com/JeninSutradhar/SimpleWikiBrowserJava)` with the actual URL of your GitHub repository.

2.  **Build the project using Maven:**

    ```bash

    mvn clean install

    ```

    This command will download any required dependencies (like JavaFX and jsoup), compile the source code and package it into a form that can be executed.

3.  **Run the application:**

    ```bash

    mvn javafx:run

    ```

    This will start the JavaFX application :)

## Troubleshooting

*   **Dependency Issues:** If you encounter errors during the `mvn clean install` step, make sure Maven is correctly configured and that you have a stable internet connection to download the project's dependencies.

*   **Java Version:** Ensure that you are using a version of Java 8 or later as specified in the `pom.xml` file.

*   **JavaFX:** JavaFX is needed for this application. If you face a javaFX error message, you should review if your Maven install is using correctly JavaFX.

## Contributing

Contributions are welcome! Feel free to submit issues and pull requests.

## License

This project is licensed under the [MIT License](LICENSE.md). (If you want to include a license)