ktor

(β˜… 14,501)

Framework for quickly creating connected applications in Kotlin with minimal effort

Showing a partial file list β€” download the zip above to see everything.

  • .coderabbit.yaml
  • .editorconfig
  • .gitattributes
  • .gitignore
  • .gitpod.yml
  • AGENTS.md
  • build.gradle.kts
  • CHANGELOG.md
  • CLAUDE.md
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • gradle.properties
  • gradlew
  • gradlew.bat
  • LICENSE
  • MIGRATION_GUIDE.md
  • README.md
  • THIRDPARTY.md
  • VERSION

πŸš€ Installation Guide

1. Get the code
git clone https://github.com/ktorio/ktor

Downloads the entire project code from GitHub to your computer.

cd ktor

Moves into the project folder you just downloaded.

2. Gradle (Java/Kotlin)

Medium Recommended
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.
./gradlew run

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.

3. Rust

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Rust (rustup) Installing via rustup also installs cargo.
cd ktor-client/ktor-client-webrtc/ktor-client-webrtc-rs

This project's files live in a subfolder, so move into it first.

cargo build --release

Compiles the Rust project.

cargo run

Builds and then immediately runs the program.

βœ… If cargo build finishes without errors, it worked. The executable is created under target/.
// repository documentation