limbus_server

This project was created using the Ktor Project Generator.

Here are some useful links to get you started:

• Ktor Documentation
• Ktor GitHub page
• The Ktor Slack chat. You'll need to request an invite to join.

Features

Here's a list of features included in this project:

Name	Description
Rate Limiting	Manage request rate limiting as you see fit
Routing	Provides a structured routing DSL
WebSockets	Adds WebSocket protocol support for bidirectional client connections
kotlinx.serialization	Handles JSON serialization using kotlinx.serialization library
Content Negotiation	Provides automatic content conversion according to Content-Type and Accept headers
Postgres	Adds Postgres database to your application
Exposed	Adds Exposed database to your application
Micrometer Metrics	Enables Micrometer metrics in your Ktor server application.
Metrics	Adds supports for monitoring several metrics
Call Logging	Logs client requests
Status Pages	Provides exception handling for routes
Static Content	Serves static files from defined locations
Server-Sent Events (SSE)	Support for server push events
Sessions	Adds support for persistent sessions through cookies or headers
Authentication	Provides extension point for handling the Authorization header
Authentication JWT	Handles JSON Web Token (JWT) bearer authentication scheme
Authentication OAuth	Handles OAuth Bearer authentication scheme
Swagger	Serves Swagger UI for your project
CORS	Enables Cross-Origin Resource Sharing (CORS)
OpenAPI	Serves OpenAPI documentation
Koin	Provides dependency injection

Building & Running

To build or run the project, use one of the following tasks:

Task	Description
./gradlew test	Run the tests
./gradlew build	Build everything
buildFatJar	Build an executable JAR of the server with all dependencies included
buildImage	Build the docker image to use with the fat JAR
publishImageToLocalRegistry	Publish the docker image locally
run	Run the server
runDocker	Run using the local docker image

If the server starts successfully, you'll see the following output:

2024-12-04 14:32:45.584 [main] INFO  Application - Application started in 0.303 seconds.
2024-12-04 14:32:45.682 [main] INFO  Application - Responding at http://0.0.0.0:8080