Giter Club home page Giter Club logo

kotlin-ktor-realworld-example-app's Introduction

Travis Codacy Badge BCH compliance

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 + Kodein + Exposed 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.

How it works

The application was built with:

  • Kotlin as programming language
  • Ktor as web framework
  • Kodein as dependency injection framework
  • Jackson as data bind serialization/deserialization
  • Java-jwt for JWT spec implementation
  • HikariCP as datasource to abstract driver implementation
  • H2 as database
  • Exposed as Sql framework to persistence layer
  • slugify

Tests:

Structure

  + config/
      All app setups. Ktor, Kodein and Database
  + domain/
    + repository/
        Persistence layer and tables definition
    + service/
        Logic layer and transformation data
  + ext/
      Extension of String for email validation
  + utils/
      Jwt and Encrypt classes
  + web/
    + controllers
        Classes and methods to mapping actions of routes
    Router definition to features and exceptions
  - App.kt <- The main class

Getting started

You need just JVM installed.

The server is configured to start on 8080.

Build:

./gradlew clean build

Start the server:

./gradlew run

In the project have the spec-api with the README and collections to execute backend tests specs realworld.

Execute tests and start the server:

./gradlew run & APIURL=http://localhost:8080 ./spec-api/run-api-tests.sh

Help

Please fork and PR to improve the code.

kotlin-ktor-realworld-example-app's People

Contributors

rudge avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.