GithubHelp home page GithubHelp logo

crudk's Introduction

Crudk - a simple webserver

What is the plan?

Creating a CRUD component in Kotlin that can work as a starting building block in a microservice world.

Where to start next time

Dependency injection - framework or just create classes?

TODOs in prioritized order

  • Implement multiple routes
  • Connect Ktorm to SQL database
  • Correlation ID on calls
  • API tests (http calls/headers etc.)
  • Service tests (dependency injection)
  • Repository tests (DB testing! Create DB in docker container and run queries)
  • Tests that uses MockK (mocking API, DI and DB)
  • Tests that uses JUnit5
  • Add Jacoco for test coverage
  • Implement keycloak authentication (or other sufficient auth standard protocol)
  • Decide on dependency injection
  • Docker multistage build
  • Expose Prometheus stats
  • Swagger documentation
  • Find nice-to-haves and create a prioritized TODO

Ktor

Ktor is the web application framework used. It runs a Netty server, but it should be easy to configure it to run Jetty/Tomcat/CIO instead.

Authentication

Crudk uses OIDC/Auth2.0 in order to be able to work with Keycloak (KC). WIP!

Code to handle other authentication protocols++ will be implemented, but only after the KC implementation is working.

Ktorm

The database framework Crudk will use. WIP!

Spek

The test framework Crudk uses. WIP!

If it fails horribly at doing its job, JUnit 5 will take over.

MockK

The mocking library for testing Crudk uses. WIP!

Informational links

crudk's People

Contributors

henninglh avatar

Watchers

 avatar  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.