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.
Here's a list of features included in this project:
| Name | Description |
|---|---|
| Routing | Provides a structured routing DSL |
| Authentication | Provides extension point for handling the Authorization header |
| Authentication Digest | Handles 'Digest' authentication scheme |
| Content Negotiation | Provides automatic content conversion according to Content-Type and Accept headers |
| kotlinx.serialization | Handles JSON serialization using kotlinx.serialization library |
| Sessions | Adds support for persistent sessions through cookies or headers |
| Request Validation | Adds validation for incoming requests |
| Resources | Provides type-safe routing |
| Static Content | Serves static files from defined locations |
| Status Pages | Provides exception handling for routes |
| CORS | Enables Cross-Origin Resource Sharing (CORS) |
| Compression | Compresses responses using encoding algorithms like GZIP |
| Forwarded Headers | Allows handling proxied headers (X-Forwarded-*) |
| Jackson | Handles JSON serialization using Jackson library |
| Thymeleaf | Serves HTML content, templated using Thymeleaf |
| WebSockets | Adds WebSocket protocol support for bidirectional client connections |
| Rate Limiting | Manage request rate limiting as you see fit |
| Shutdown URL | Enables a URL that shuts down the server when accessed |
| Webjars | Bundles static assets into your built JAR file |
| HSTS | Enables HTTP Strict Transport Security (HSTS) |
| Simple Cache | Provides API for cache management |
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
MIT License
Copyright (c) 2025 Ron Lauren Hombre, Sander Melvert Gervacio, Reinier Anthony Casimiro, John Michael Almazan, Einar Pacanza, Niko Bongo
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.