Coffee

Coffee is a light and quick package for writing desktop applications using familiar web technologies and frameworks. Uses Webview and is inspired by the wailsapp project. for a more detailed overview of the package, click here

Requirements

• Java 11 or above.
• Maven installed on you system. You can download here.
• NodeJS and NPM (18.0+)

Get Started

CLI

If you have Golang installed, you can use:

go install github.com/YairLevi/Coffee/cli/coffee@latest

Otherwise, you can download it from here. Add the executable to some PATH folder, for convenience.

Usage is quick and easy:

• init for creating new projects -

  > coffee init <backend-template> <frontend-template>
  

• dev for running in development mode -

  > coffee dev
  

• build for packaging the application into a .jar file -
  

  > coffee build 
  

Example

The code for both Java and Kotlin is pretty much the same.

import org.levi.coffee.Ipc
import org.levi.coffee.Window
import org.levi.coffee.annotations.BindMethod
import org.levi.coffee.annotations.BindType

@BindType
class MyClass(
    val name: String = "",
    var age: Int = 0,
    val hobbies: List<String> = emptyList(),
) {
    @BindMethod
    fun add(a: Int, b: Int): Int {
        return a + b
    }

    @BindMethod
    fun incrementAndInvoke() {
        age++;
        println("My age increased to $age")
        println("invoking event...")
        Ipc.invoke("event")
    }
}

fun main() {
    val win = Window()
    win.setSize(700, 700)
    win.setTitle("My first Coffee app!")
    win.setURL("http://localhost:5173")
    // Or some html... using win.setHTML("<!DOCTYPE...")
    win.bind(
        MyClass(),
    )
    win.addBeforeStartCallback { println("Started app...") }
    win.addOnCloseCallback { println("Closed the app!") }

    win.run()
}