KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#developer-tools #typescript #codex #ai-agents #claude-code #dsh #dsh-plugin #cli #macos #ai-agent #deepseek-harness #open-source

worldclock

★ 32 Open GitHub ↗

A Sci-fi looking World Clock created using JavaFX.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# World Clock - A JavaFX World Clock
Welcome to the World Clock application! This project is for a series of blog entries at https://foojay.io

- https://foojay.io/today/creating-a-javafx-world-clock-from-scratch-part-1
- https://foojay.io/today/creating-a-javafx-world-clock-from-scratch-part-2
- https://foojay.io/today/creating-a-javafx-world-clock-from-scratch-part-3
- https://foojay.io/today/creating-a-javafx-world-clock-from-scratch-part-4
- https://foojay.io/today/creating-a-javafx-world-clock-from-scratch-part-5
- https://foojay.io/today/creating-a-javafx-world-clock-from-scratch-part-6

![A JavaFX World Clock](https://github.com/carldea/worldclock/blob/main/world-clock-part1_1.png?raw=true)
![A JavaFX World Clock Config](https://github.com/carldea/worldclock/blob/main/world-clock-part3_1.png?raw=true)

This is a standard Maven JavaFX modular (JPMS) application.

## Requirements:
- Maven 3.6.3 or greater
- Java 16+
- Bach (https://github.com/sormuras/bach) (Optional)
- Register and obtain an appid (api key) from [OpenWeatherMap.org](https://openweathermap.org/)

## OpenJDK build recommendations or suggestions
It's recommended to use an OpenJDK distro that already contains the OpenJFX libraries such as Azul's Zulu builds with JavaFX.
If not, then you can uncomment the dependencies needed in the pom.xml file.

## Create a resource file containing the appid from OpenWeatherMap.org
Because the World Clock app uses a weather service, the app will need to obtain the appid from a file you'll need to create locally. After registering and obtaining your API key you’ll need to add the API key into a text file named `openweathermap-appid.txt`. The file will need to be located in the project’s directory: `src/main/resources/com/carlfx/worldclock/`.

The appid (API key) file is private (local) and will be ignored by GitHub (not checked into GitHub). An entry exists to ignore the file inside the `.gitignore` file. So, when you build the application local to you the resource file will be included in your build.
## Build project using Bach

`$ .bach/bin/bach build`

To simplify add to your .bashrc or .bash_profile as the following:

`export PATH=$PATH:.bach/bin`

Open a new terminal session to be able to run Bach build tool.

On Windows you'll add to your environment variables as the following:

`set PATH=%PATH%;.bach\bin`

### Run World Clock as a module

`$ java --add-modules worldclock --module-path .bach/workspace/modules/:.bach/external-modules/ com.carlfx.worldclock.Launcher`

### Run World Clock using a custom image

```bash
# Linux/MacOS
$ .bach/workspace/image/bin/worldclock
```

```bash
# Windows 
$ .bach\workspace\image\bin\worldclock
```

## Clean project using Maven

`$ mvn clean`

## Run World Clock using Maven plugin
This will compile and build the JavaFX project locally using the Maven plugin.

`$ mvn javafx:run`

## Create a custom image (Java runtime w/world clock executable)
`$ mvn javafx:jlink`

## Create a MacOS package to run allow user to install onto desktop
The following assumes the prior step completed successfully. The runtime artifacts reside in the target/worldclock directory.
```bash
$ jpackage --verbose \
      --name "JFX World Clock" \
      --description "JavaFX World Clock Application" \
      --vendor "Carl Dea" \
      --runtime-image target/worldclock/ \
      --module worldclock/com.carlfx.worldclock.Launcher \
      --dest release
```

# Outstanding issues
1. The map doesn't load properly when building and running the app as a built image.
2. Map uses MapBox and Leaflet.js an access_token needs to be created. See https://www.mapbox.com/studio/account/tokens/ for details.

worldclock

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README