ktor boiler plate project

Developing

To run the backend in locally:

docker-compose up -d
./gradlew run

To run the backend itself with docker compose:

docker-compose --profile backend up

Testing the API

Once the application is running, you can test the User API using curl.

Create a User

curl -X POST -H "Content-Type: application/json" \
  -d '{"name": "Jane Doe", "email": "jane@example.com"}' \
  http://localhost:8080/users

Get All Users

curl http://localhost:8080/users

API Documentation

You can access the interactive Swagger UI documentation at:

http://localhost:8080/swagger

This allows you to explore endpoints and test requests directly from your browser.

Running Tests

The project includes integration tests that use an in-memory H2 database.

./gradlew test

Static Analysis & Formatting

We use Detekt for static analysis and formatting (via detekt-formatting).

./gradlew detekt