Skip to content
High performance asynchronous non-blocking I/O, event-driven Java API boilerplate
Java Dockerfile
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/workflows
gradle/wrapper
src
.classpath
.editorconfig
.gitignore
.project
Dockerfile
README.md
build.gradle
docker-compose.yml
gradlew
gradlew.bat
settings.gradle

README.md

Java API Boilerplate

Quick Start

  • Install Java and JDK and Docker.
  • Run docker-compose up -d to start MongoDB in background (or you can start with local MongoDB).
  • Run ./gradlew clean run to start development.
  • Run ./gradlew test to run tests.

Production Build

  • Run ./gradlew clean assemble to build.
  • Start in JVM with java -jar ./build/libs/api-1.0.0-SNAPSHOT-fat.jar.
  • Or start with Docker docker build -t java-api . and docker run -d -p 5000:5000 java-api:latest.

Workflow

Branch naming:

  • Feature: feature/add-new-button
  • Hotfix: hotfix/fix-bug-abc
  • Improvement: improve/improve-button-abc

Commits:

  • Commit should not capitalize first character, example: migrate to hooks

Stack:

Fastest JVM ever, lighweight JVM-memory-footprint and size (~30MB memory, ~24.5MB jar file), fast bootup, hot-reload supported, non-blocking I/O JVM based on Netty/Vertx, event driven with reactive programming.

  • Java/JVM
  • RxJava
  • Vert.x (Netty based)
  • MongoDB Client
  • JUnit

You can’t perform that action at this time.