README.md

basicFX-webBrowser

Andrew Osterhout (a02201315)
USU: Sp2020 -> CS2410: Event Driven Programing and GUI's
Final Project: basicFX-webBrowser

About:

This is a basic web browser with some limited themeing options and basic history and bookmarking features built in.

Disclaimer:

This is a basic web browser built using JavaFX in using JDK-10 (which was out of support when made), as a final project for Utah State University's (USU) CS2410 Event Driven Programing and GUI's course. As such this is not a secure web browser, nor a fast web browser, using outdated and unsupported development tools. It should not be used as your daily driver web browser. It exists on the web as the beginnings of a personal portfolio, and an exercise in developing and showing off different techniques and methodologies of event driven programing and building GUI interfaces.

Project Table Of Contents:

• basicFX-webBrowser

  • About:
    • Disclaimer:
  • Project Table Of Contents:
  • Notes:
    • Mermaid:
  • Getting Started:
    • vs-code:
    • Other IDEs:
    • Command line:

• Documentation:

  • Assignment Description
  • Credit
    • Developer(s):
    • Third Party Assets and Libraries:
      • Java External Libraries:
      • JavaFX CSS themes:
      • HTML page Assets:
        
        

Notes:

Mermaid:

When going through the documentation you will find sections of the markdown that will render like this:

classDiagram
    class example~test~ {
        int item
        - exampleMethod() String
    }

This is Mermaid Diagraming Language (about) (GitHub) (user manual), and to get it to render you will need to add support to your markdown viewer, via one of the following:

• GitHub+mermaid chrome-extension (GitHub)
• vs-code Mermaid in markdown Preview Extension (GitHub)
• Paid IntelliJ Markdown enhanced Plugin

You can also use the Mermaid live editor, by coppying and pasting the mermaid code to the editor to get the picture.

When you have added mermaid support into your markdown rendering engine you should get diagrams like this:

Getting Started:

This is not meant to be an application for every day use, so is best run in a developer environment of some kind.

First thing you will need to do is clone or download this repo:

git clone <URL/SSH> basicFX-webBrowser

Then run it in the development environment of your choice using jdk-10 (available to download via the oracle archives here).

vs-code:

If you want to run the application, this repo contains all of the vs-code workspace files nessisary to run it in vs code with the Java Extension pack installed along with it. In addition you will need to set your "java.home" setting to your copy of the JDK10, or use the >java: COnfigure Java Runtime command from the command pallet and do it there.

Other IDEs:

If you are usign another IDE vs-code's java language server implements Eclipse's project format so you can usually just import it as a Eclipse project into an IDE like IntelliJ (by jet-brains), Eclipse or NetBeans with minimal issues.

Command line:

If you are good at old school command line java development, you don't need me to tell you how to do what you need to do.