37 lines
1.8 KiB
Markdown
37 lines
1.8 KiB
Markdown
# ktor
|
|
|
|
This project was created using the [Ktor Project Generator](https://start.ktor.io).
|
|
|
|
Here are some useful links to get you started:
|
|
|
|
- [Ktor Documentation](https://ktor.io/docs/home.html)
|
|
- [Ktor GitHub page](https://github.com/ktorio/ktor)
|
|
- The [Ktor Slack chat](https://app.slack.com/client/T09229ZC6/C0A974TJ9). You'll need to [request an invite](https://surveys.jetbrains.com/s3/kotlin-slack-sign-up) to join.
|
|
|
|
## Features
|
|
|
|
Here's a list of features included in this project:
|
|
|
|
| Name | Description |
|
|
| ----------------------------------------------------|------------------------------------------------------------- |
|
|
| [AsyncAPI](https://start.ktor.io/p/asyncapi) | Generates and serves AsyncAPI documentation |
|
|
| [Routing](https://start.ktor.io/p/routing-default) | Allows to define structured routes and associated handlers. |
|
|
|
|
## Building & Running
|
|
|
|
To build or run the project, use one of the following tasks:
|
|
|
|
| Task | Description |
|
|
| -----------------------------------------|---------------------------------------------------------------------- |
|
|
| `./gradlew nativeTest` | Run the tests |
|
|
| `./gradlew build` | Build everything |
|
|
| `./gradlew runDebugExecutableNative` | Run the server |
|
|
|
|
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
|
|
```
|
|
|