{"id":22475398,"url":"https://github.com/fugerit-org/graalkus","last_synced_at":"2025-07-03T17:32:49.177Z","repository":{"id":265923719,"uuid":"896396559","full_name":"fugerit-org/graalkus","owner":"fugerit-org","description":"Graalkus: Let Quarkus fly high with GraalVM.","archived":false,"fork":false,"pushed_at":"2025-05-01T06:42:57.000Z","size":15625,"stargazers_count":4,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-05-01T07:23:42.372Z","etag":null,"topics":["container","docker","graalvm","graalvm-native-image","java","quarkus"],"latest_commit_sha":null,"homepage":"https://graalkus.fugerit.org/","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fugerit-org.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-11-30T08:49:59.000Z","updated_at":"2025-05-01T06:42:18.000Z","dependencies_parsed_at":"2024-12-27T23:34:18.454Z","dependency_job_id":"702b9358-6a58-46a2-90df-2e4804cb45f2","html_url":"https://github.com/fugerit-org/graalkus","commit_stats":null,"previous_names":["fugerit-org/graalkus"],"tags_count":13,"template":false,"template_full_name":null,"purl":"pkg:github/fugerit-org/graalkus","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fugerit-org%2Fgraalkus","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fugerit-org%2Fgraalkus/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fugerit-org%2Fgraalkus/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fugerit-org%2Fgraalkus/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fugerit-org","download_url":"https://codeload.github.com/fugerit-org/graalkus/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fugerit-org%2Fgraalkus/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263369650,"owners_count":23456336,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["container","docker","graalvm","graalvm-native-image","java","quarkus"],"created_at":"2024-12-06T13:16:06.242Z","updated_at":"2025-07-03T17:32:49.127Z","avatar_url":"https://github.com/fugerit-org.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# graalkus\n\n[![Keep a Changelog v1.1.0 badge](https://img.shields.io/badge/changelog-Keep%20a%20Changelog%20v1.1.0-%23E05735)](https://github.com/fugerit-org/graalkus/blob/master/CHANGELOG.md)\n[![license](https://img.shields.io/badge/License-MIT%20License-teal.svg)](https://opensource.org/license/mit)\n[![code of conduct](https://img.shields.io/badge/conduct-Contributor%20Covenant-purple.svg)](https://github.com/fugerit-org/fj-universe/blob/main/CODE_OF_CONDUCT.md)\n[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=fugerit-org_graalkus\u0026metric=alert_status)](https://sonarcloud.io/summary/new_code?id=fugerit-org_graalkus)\n[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=fugerit-org_graalkus\u0026metric=coverage)](https://sonarcloud.io/summary/new_code?id=fugerit-org_graalkus)\n[![Docker images](https://img.shields.io/badge/dockerhub-images-important.svg?logo=Docker)](https://hub.docker.com/repository/docker/fugeritorg/graalkus/general)\n\n[![Java runtime version](https://img.shields.io/badge/run%20on-java%2021+-%23113366.svg?style=for-the-badge\u0026logo=openjdk\u0026logoColor=white)](https://universe.fugerit.org/src/docs/versions/java21.html)\n[![Java build version](https://img.shields.io/badge/build%20on-GraalVM%2021+-%23ED8B00.svg?style=for-the-badge\u0026logo=openjdk\u0026logoColor=white)](https://universe.fugerit.org/src/docs/versions/gvm21.html)\n[![Apache Maven](https://img.shields.io/badge/Apache%20Maven-3.9.0+-C71A36?style=for-the-badge\u0026logo=Apache%20Maven\u0026logoColor=white)](https://universe.fugerit.org/src/docs/versions/maven3_9.html)\n\n## Documentation\n\nNOTE: The documentation (HTML, PDF and slides) is produced with a doc-as-code approach. Only my IDE and GIT have been used. No office automation tools were harmed in the making of this project 😉.\n\n[Here you can find project documentation index](https://graalkus.fugerit.org/) published through GitHub pages.\n\nIntroduction slides are available thanks to [Slidev](https://sli.dev/) : \n\n[![Slideshow](https://img.shields.io/badge/HTML-Slideshow-greeb?style=for-the-badge)](https://graalkus.fugerit.org/graalkus-slidev/ \"Go to project Slideshow\")\n\nWhile [AsciiDoc](https://asciidoc.org/) full documentation is here :\n\n[![HTML - Documentation](https://img.shields.io/badge/HTML-Documentation-blue?style=for-the-badge)](https://graalkus.fugerit.org/book/ \"Go to project HTML documentation\")\n[![PDF - Documentation](https://img.shields.io/badge/PDF-Documentation-red?style=for-the-badge)](https://graalkus.fugerit.org/book/graalkus.pdf \"Go to project PDF documentation\")\n\n\n## Quickstart\n\nRequirement :\n\n* maven 3.9.x\n* java 21+ (GraalVM for native version)\n\nNOTE: All benchmarks has been run on Oracle GraalVM 23.\n\n1. Verify the app\n\n```shell\nmvn verify\n```\n\n2. Start the app\n\n```shell\nmvn quarkus:dev\n```\n\n3. Try the app\n\nOpen the [swagger-ui](http://localhost:8080/q/swagger-ui/)\n\nTest available paths (for instance : [/doc/example.md](http://localhost:8080/doc/example.md))\n\n## Native version\n\nIf you picked only native modules, you should be able to build and run the AOT version (GraalVM 21+ needed).\n\nFurther documentation :\n\n* [List of modules and native support](https://venusdocs.fugerit.org/guide/#available-extensions)\n* [Fugerit Venus Doc native support introduction](https://venusdocs.fugerit.org/guide/#doc-native-support)\n\n1. Build and verify\n\n```shell\nmvn package -Dnative\n```\n\n2. Start\n\n```shell\n./target/graalkus-*-runner\n```\n\n## Container deployment\n\nRequirement :\n\n* Container environment (Docker or Podman)\n\n\u003e Note: It is recommended to install the latest versions of [Docker Desktop](https://www.docker.com/products/docker-desktop/) or [Podman Desktop](https://podman-desktop.io/). \n\nPick a docker compose file (inside the [src/main/docker](src/main/docker)) and run by using docker compose or podman compose. Se example below: \n\n```shell\n# If you have a docker environment\n# This syntax of docker compose is available from then Docker Desktop 3.4\ndocker compose -f src/main/docker/docker-compose.yml up -d\n\n# If you have a podman environment\n# This syntax of podman compose is available from the Podman 4.0\npodman compose -f src/main/docker/docker-compose.yml up -d\n```\n\nNOTE: both amd64 and arm64 (including macOS) [pre-built images](https://hub.docker.com/r/fugeritorg/graalkus) are available.\n\n## Run benchmark with siege\n\nRequirement :\n\n* siege\n* psrecord (optional for plotting)\n\nStart the application and run :\n\n```shell\n./src/main/script/bench-graph-siege.sh \n```\n\nThe result output file is in the `target` directory.\n\n## Run benchmark with h2load\n\nRequirement :\n\n* h2load\n* psrecord (optional for plotting)\n\nStart the application and run : \n\n```shell\n./src/main/script/bench-graph-h2-load.sh \n```\n\nThe result output file is in the `target` directory.\n\n## Run benchmark on different url\n\nDefault for benchmark is to run on http://localhost:8080.\n\nTo run on a different url use the -u parameter, for instance : \n\n```shell\n./src/main/script/bench-graph-h2-load.sh -u http://localhost:8081\n```\n\nThe result output file is in the `target` directory.\n\n## Run benchmark with plotting\n\nTo run benchmark with plotting, psrecord should be installed.\n\nBuild the application without launching it, and run : \n\n```shell\nmvn install -Dnative\n./src/main/script/bench-graph-h2-load.sh -m AOT\n```\n\nor \n\n```shell\nmvn package\n./src/main/script/bench-graph-h2-load.sh -m JIT\n```\n\nThe result output file is in the `target` directory.\n\n## Build the documentation\n\nRequirement : \n\n* NodeJS 20+\n* Mermaid CLI\n\n### AsciiDoc documentation\n\n[AsciiDoc](https://asciidoc.org/) source folder is located at : \n\n[src/main/docs/asciidoc](src/main/docs/asciidoc)\n\nIt is possible to build HTML and PDF documentation running : \n\n```shell\nmvn install -Pdocs\n```\n\nOutput will be in `target/site` directory.\n\n### Slidev slideshow\n\n[Slidev](https://sli.dev/) source folder is located at : \n\n[src/main/docs/slidev/graalkus](src/main/docs/slidev/graalkus)\n\nTo run the slideshow in dev mode just : \n\n```shell\ncd src/main/docs/slidev/graalkus\nnpm install\nnpm run dev\n```\n\nFor a production build : \n\n```shell\nmvn clean install -Pslidev\nserve src/main/docs/slidev/graalkus\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffugerit-org%2Fgraalkus","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffugerit-org%2Fgraalkus","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffugerit-org%2Fgraalkus/lists"}