https://github.com/dragneelfps/realworld-kotlin-ktor

RealWorld Kotlin Ktor Backend
https://github.com/dragneelfps/realworld-kotlin-ktor

Last synced: 29 days ago
JSON representation

RealWorld Kotlin Ktor Backend

• Host: GitHub
• URL: https://github.com/dragneelfps/realworld-kotlin-ktor
• Owner: dragneelfps
• Created: 2019-06-18T18:33:54.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2022-07-23T07:43:29.000Z (over 2 years ago)
• Last Synced: 2023-11-07T19:05:19.817Z (about 1 year ago)
• Language: Kotlin
• Homepage: https://realworld.io/
• Size: 195 KB
• Stars: 172
• Watchers: 2
• Forks: 14
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-ktor - RealWorld Kotlin Ktor Backend - Ktor codebase containing real world examples (CRUD, auth, advanced patterns, etc) that adheres to the RealWorld spec and API. (Educational Projects / Episodes)
• awesome-ktor - RealWorld Kotlin Ktor Backend - Ktor codebase containing real world examples (CRUD, auth, advanced patterns, etc) that adheres to the RealWorld spec and API. (Educational Projects / Episodes)

README

        
# ![RealWorld Example App](logo.png)

> ### [Kotlin-Ktor](https://github.com/kotlin/ktor) codebase containing real world examples (CRUD, auth, advanced patterns, etc) that adheres to the [RealWorld](https://github.com/gothinkster/realworld) spec and API.

### [Demo](https://github.com/gothinkster/realworld)    [RealWorld](https://github.com/gothinkster/realworld)

This codebase was created to demonstrate a fully fledged fullstack application built with **[Kotlin-Ktor](https://github.com/kotlin/ktor)** including CRUD operations, authentication, routing, pagination, and more.

We've gone to great lengths to adhere to the **[Kotlin-Ktor](https://github.com/kotlin/ktor)** community styleguides & best practices.

For more information on how to this works with other frontends/backends, head over to the [RealWorld](https://github.com/gothinkster/realworld) repo.

# Build Status

![Build](https://github.com/dragneelfps/realworld-kotlin-ktor/workflows/Build/badge.svg?branch=master)

# How it works

- [h2](https://h2database.com/html/main.html) database

- [hikari](https://github.com/brettwooldridge/HikariCP) as JDBC connection pool

- [Exposed](https://github.com/JetBrains/Exposed/) as Kotlin SQL Framework

- [Jackson](https://github.com/FasterXML/jackson) for handling JSON

- [Koin](https://insert-koin.io/) 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](http:localhost:8080/api), if using default configuration. 

4. Yay.

> Testing

1. ./gradlew build test