An open API service indexing awesome lists of open source software.

https://github.com/quarkusio/quarkus-zulip-bot

Quarkus Zulip Bot
https://github.com/quarkusio/quarkus-zulip-bot

Last synced: 3 months ago
JSON representation

Quarkus Zulip Bot

Awesome Lists containing this project

README

        

# Quarkus Zulip Bot

> A Quarkus-powered Zulip Bot to automate common tasks in the Quarkus Zulip chat server.

The Quarkus Zulip bot uses [Outgoing Webhooks](https://zulip.com/api/outgoing-webhooks) for being notified when mentioned and the [Zulip REST API](https://zulip.com/api/rest) for extra interactions,
like adding a emoji reaction to a message or to send an additional message without being explicitly mentioned, for example.

## Running the application in dev mode

You can run your application in dev mode that enables live coding using:
```shell script
./mvnw compile quarkus:dev
```

> **_NOTE:_** Quarkus now ships with a Dev UI, which is available in dev mode only at http://localhost:8080/q/dev/.

## Packaging and running the application

The application can be packaged using:
```shell script
./mvnw package
```
It produces the `quarkus-run.jar` file in the `target/quarkus-app/` directory.
Be aware that it’s not an _über-jar_ as the dependencies are copied into the `target/quarkus-app/lib/` directory.

If you want to build an _über-jar_, execute the following command:
```shell script
./mvnw package -Dquarkus.package.type=uber-jar
```

The application is now runnable using `java -jar target/quarkus-app/quarkus-run.jar`.

## Creating a native executable

You can create a native executable using:
```shell script
./mvnw package -Pnative
```

Or, if you don't have GraalVM installed, you can run the native executable build in a container using:
```shell script
./mvnw package -Pnative -Dquarkus.native.container-build=true
```

You can then execute your native executable with: `./target/quarkus-zulip-1.0.0-SNAPSHOT-runner`

If you want to learn more about building native executables, please consult https://quarkus.io/guides/maven-tooling.html.