Skip to content

Latest commit

 

History

History
41 lines (25 loc) · 1.65 KB

README.md

File metadata and controls

41 lines (25 loc) · 1.65 KB

RealWorld Example App

Kotlin-Ktor codebase containing real world examples (CRUD, auth, advanced patterns, etc) that adheres to the RealWorld spec and API.

This codebase was created to demonstrate a fully fledged fullstack application built with Kotlin-Ktor including CRUD operations, authentication, routing, pagination, and more.

We've gone to great lengths to adhere to the Kotlin-Ktor community styleguides & best practices.

For more information on how to this works with other frontends/backends, head over to the RealWorld repo.

Build Status

Build

How it works

  • h2 database
  • hikari as JDBC connection pool
  • Exposed as Kotlin SQL Framework
  • Jackson for handling JSON
  • Koin for dependency injection

Getting started

Installation

  1. Install h2 database. Default configuration uses server mode.
  2. Run the gradle. :)

Running

  1. Start the h2 database
  2. Run the gradle. :))
  3. Check on http://localhost:8080/api, if using default configuration.
  4. Yay.

Testing

  1. ./gradlew build test