CodelyTV / kotlin-api-skeleton

💎 Kotlin Hexagonal HTTP API template to create your new projects

💎 Kotlin HTTP API Skeleton

Template intended to serve as a starting point if you want to bootstrap a Kotlin HTTP API.

Take a look, play and have fun with this. Stars are welcome 😊

This is a repository intended to serve as a starting point if you want to bootstrap an API in Kotlin.

☝️ Introduction

It could be useful if you want to start from scratch a kata or a little exercise or project. The idea is that you don't have to worry about the boilerplate

• Latest stable kotlin version
• Latest stable Springboot version
• Latest stable java version
• Best practices applied
• Some useful resources to start coding

🌎 How To Start

You could manually clone this repo or just us it as a template

Cloning the repository

We recommend to follow the next step by step process in order to avoid adding the bootstrap project commits to your project Git history:

1. Use this repositoy template
2. Clone your project
3. Move to the project directory: cd your-project-name
4. Build the project for the first time: ./gradlew build
5. Run all the checks: ./gradlew check. This will do some checks that you can perform with isolated commands:
   1. Klint using Spotless: ./gradlew spotlessCheck. If you want to fix style issues automatically: ./gradlew spotlessApply.
   2. Kotlin test: ./gradlew test.
6. To just run the project execute: ./gradlew run
7. Start coding!

👌 Helpful resources

Kotlin

• Kotlin Coding Conventions
• Comparison between Kotlin and Java

Kotlin test

• Test code using JUnit in JVM - tutorial
• JUnit5 assertions

👌 Codely Code Quality Standards

Publishing this package we are committing ourselves to the following code quality standards:

• 🤝 Respect Semantic Versioning: No breaking changes in patch or minor versions
• 🤏 No surprises in transitive dependencies: Use the bare minimum dependencies needed to meet the purpose
• 🎯 One specific purpose to meet without having to carry a bunch of unnecessary other utilities
• ✅ Tests as documentation and usage examples
• 📖 Well documented ReadMe showing how to install and use
• ⚖️ License favoring Open Source and collaboration

🔀 Related skeleton templates

Opinionated TypeScript skeletons ready for different purposes:

• 🔷🌱 TypeScript Basic Skeleton
• 🔷🕸️ TypeScript Web Skeleton
• 🔷🌍 TypeScript API Skeleton
• 🔷✨ TypeScript DDD Skeleton

This very same basic skeleton philosophy implemented in other programming languages:

• ✨ JavaScript Basic Skeleton
• ☕ Java Basic Skeleton
• 📍 Kotlin Basic Skeleton
• 🧬 Scala Basic Skeleton
• 🦈 C# Basic Skeleton
• 🐘 PHP Basic Skeleton