https://github.com/amaziahub/tunic

A minimal setup for a Kotlin application using Gradle
https://github.com/amaziahub/tunic

functional-programming java jvm kotlin

Last synced: 8 months ago
JSON representation

A minimal setup for a Kotlin application using Gradle

• Host: GitHub
• URL: https://github.com/amaziahub/tunic
• Owner: amaziahub
• License: apache-2.0
• Created: 2025-01-05T14:00:31.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2025-01-06T15:44:44.000Z (about 1 year ago)
• Last Synced: 2025-02-25T20:32:27.118Z (about 1 year ago)
• Topics: functional-programming, java, jvm, kotlin
• Language: Kotlin
• Homepage:
• Size: 16.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          





> **tunic** – A minimal setup for a Kotlin application using Gradle.





![Kotlin](https://img.shields.io/badge/kotlin-1.9.0-blue.svg?logo=kotlin&logoColor=white)

![Gradle](https://img.shields.io/badge/gradle-8.4-%2302303A.svg?logo=gradle)

[![Last Commit](https://img.shields.io/github/last-commit/amaziahub/tunic.svg)](https://github.com/amaziahub/tunic/commits/main)

[![License](http://img.shields.io/:license-apache2.0-red.svg)](http://doge.mit-license.org)

![Made with ❤️](https://img.shields.io/badge/made%20with-%E2%9D%A4-red.svg)





---

## Prerequisites

Ensure the following are installed on your system:

- [Java Development Kit (JDK)](https://adoptopenjdk.net/) 8 or later

- [Gradle](https://gradle.org/install/)

- [Make](https://www.gnu.org/software/make/)

---

## Project Structure

```text

simple-gradle-kotlin-project/ 

├── build.gradle.kts # Gradle build script (Kotlin DSL) 

├── settings.gradle.kts # Gradle settings 

├── Makefile # Makefile for simplified task execution 

├── src/ 

│ ├── main/ 

│ │ └── kotlin/ 

│ │     └── Main.kt # Main application code 

│ └── test/ 

│   └── kotlin/ 

│       └── MainTest.kt # Unit tests 

└── build/ # Generated build files (ignored in VCS)

```

---

## Usage

To simplify project management, a `Makefile` is provided. Use the following commands to perform common tasks:

### Build the Project

Compiles the source code and generates the build artifacts.

```bash

  make build

```

### Run Tests

Executes the unit tests and generates a report.

```bash

  make test

```

### View Test Report

Opens the HTML test report in your default browser.

```bash

  make report

```

### Run the Application

Runs the main application.

```bash

  make run

```

---

Happy coding! 🎉