fabrikt

(โ˜… 283)

Generates Kotlin Code from OpenAPI 3 Specifications

  • .gitattributes
  • .gitignore
  • AGENTS.md
  • ARCHITECTURE.md
  • build.gradle.kts
  • CLAUDE.md
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • Dockerfile
  • Dockerfile.release
  • gradlew
  • gradlew.bat
  • LICENSE
  • README.md
  • SECURITY.md
  • settings.gradle.kts

# Installation Guide

1. Get the code
git clone https://github.com/fabrikt-io/fabrikt

Downloads the entire project code from GitHub to your computer.

cd fabrikt

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker run --rm -v $(pwd):/workspace ghcr.io/fabrikt-io/fabrikt:latest \

Runs the built image as an actual container.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Gradle (Java/Kotlin)

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • JDK (Java) Required to build and run Java/Kotlin projects.
  • Gradle If the repo includes gradlew (Gradle Wrapper), you don't need to install Gradle separately.
withType<org.jetbrains.kotlin.gradle.tasks.KotlinCompile> {

Builds the project using Gradle.

// find latest version: https://github.com/acanda/fabrikt-gradle-plugin/releases

Builds the project using Gradle.

id("ch.acanda.gradle.fabrikt") version "1.39.1"

Builds the project using Gradle.

./gradlew clean build

Builds the project using Gradle.

โœ… A BUILD SUCCESSFUL message means it worked. The output is created under build/.

Pulled directly from this repo's README.

// repository documentation