Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/codelytv/kotlin-api-skeleton
💎 Kotlin Hexagonal HTTP API template to create your new projects
https://github.com/codelytv/kotlin-api-skeleton
api hexagonal kotlin spring spring-boot testing
Last synced: 3 days ago
JSON representation
💎 Kotlin Hexagonal HTTP API template to create your new projects
- Host: GitHub
- URL: https://github.com/codelytv/kotlin-api-skeleton
- Owner: CodelyTV
- Created: 2022-08-11T14:32:15.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-25T19:24:50.000Z (10 months ago)
- Last Synced: 2024-05-01T09:38:42.681Z (7 months ago)
- Topics: api, hexagonal, kotlin, spring, spring-boot, testing
- Language: Kotlin
- Homepage: https://pro.codely.com/library/api-http-en-kotlin-aplicando-arquitectura-hexagonal-189116
- Size: 66.4 KB
- Stars: 54
- Watchers: 3
- Forks: 11
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
💎 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](https://github.com/CodelyTV/kotlin-api-skeleton) 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](https://github.com/CodelyTV/kotlin-api-skeleton/generate)
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](https://ktlint.github.io/) using [Spotless](https://github.com/diffplug/spotless): `./gradlew spotlessCheck`. If you want to fix style issues automatically: `./gradlew spotlessApply`.
2. [Kotlin test](https://kotlinlang.org/api/latest/kotlin.test/): `./gradlew test`.
6. To just run the project execute: `./gradlew run`
7. Start coding!
## 👌 Helpful resources
### Kotlin
* [Kotlin Coding Conventions](https://kotlinlang.org/docs/coding-conventions.html)
* [Comparison between Kotlin and Java](https://kotlinlang.org/docs/comparison-to-java.html)
### Kotlin test
* [Test code using JUnit in JVM - tutorial](https://kotlinlang.org/docs/jvm-test-using-junit.html)
* [JUnit5 assertions](https://junit.org/junit5/docs/5.0.1/api/org/junit/jupiter/api/Assertions.html)
## 👌 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](https://github.com/CodelyTV/typescript-basic-skeleton)
- [🔷🕸️ TypeScript Web Skeleton](https://github.com/CodelyTV/typescript-web-skeleton)
- [🔷🌍 TypeScript API Skeleton](https://github.com/CodelyTV/typescript-api-skeleton)
- [🔷✨ TypeScript DDD Skeleton](https://github.com/CodelyTV/typescript-ddd-skeleton)
This very same basic skeleton philosophy implemented in other programming languages:
- [✨ JavaScript Basic Skeleton](https://github.com/CodelyTV/javascript-basic-skeleton)
- [☕ Java Basic Skeleton](https://github.com/CodelyTV/java-basic-skeleton)
- [📍 Kotlin Basic Skeleton](https://github.com/CodelyTV/kotlin-basic-skeleton)
- [🧬 Scala Basic Skeleton](https://github.com/CodelyTV/scala-basic-skeleton)
- [🦈 C# Basic Skeleton](https://github.com/CodelyTV/csharp-basic-skeleton)
- [🐘 PHP Basic Skeleton](https://github.com/CodelyTV/php-basic-skeleton)