ksetoue / kotlin-spring-api

Spring Boot & Kotlin API Template

About

This is a template project for those who intent to start developing an API using Kotlin, Spring Boot and some initial configurations such as lint rules, logging with opentelemetry and swagger for API documentation.

Requirements

Kotlin + Spring Boot

• Kotlin
• Spring Boot
• SDKMan - necessary only to run it on your machine instead of container

Running

with docker

• Docker
• Docker Compose

Run on your terminal:

HTTPS:

git clone https://github.com/ksetoue/kotlin-spring-api.git

• How to clone a repository
• Cloning a repo with SSH
• Github CLI

Running in development mode

1. Open your terminal or console
2. test the docker ps command
3. go to the project folder then run:

   $ docker-compose up -d
   # newer versions of docker engine:
   $ docker compose up -d

Accessing

• Home endpoint will be available on http://localhost:8080/

• To access swagger go to http://localhost:8080/swagger-ui/index.html#/

---

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Karoline Setoue 💻 📖

This project follows the all-contributors specification. Contributions of any kind welcome!