Tutorial: Create your first Kotlin application
You can choose to build your app with one of the four supported build tools.
The instructions are provided for Gradle and Kotlin as DSL. To learn how to accomplish the same using other build tools, use the Build tool switcher at the top of the page.
The instructions are provided for Gradle and Groovy as DSL. To learn how to accomplish the same using other build tools, use the Build tool switcher at the top of the page.
The instructions are provided for Maven. To learn how to accomplish the same using other build tools, use the Build tool switcher at the top of the page.
The instructions are provided for IntelliJ IDEA build tool. To learn how to accomplish the same using other build tools, use the Build tool switcher at the top of the page.
Create a new project
In IntelliJ IDEA, a project helps you organize everything that is necessary for developing your application in a single unit.
- On the Welcome screen, click New Project . Otherwise, from the main menu, select File | New | Project .
- From the list on the left, select New Project .
- Name your new project and change its location if necessary.
- Select the Create Git repository checkbox to place the new project under version control. You will be able to do it later at any time.
- From the Language list, select Kotlin .
- Select the Gradle IntelliJ Maven build system.
- Choose the Groovy Kotlin language for the build script.
- From the JDK list, select the JDK that you want to use in your project. If the JDK is installed on your computer, but not defined in the IDE, select Add JDK and specify the path to the JDK home directory. If you don’t have the necessary JDK on your computer, select Download JDK .
- Enable the Add sample code option to create a file with a sample Hello World! application.
- Click Create .
Write code
Source code is the central part of your project. In source code, you define what your application will be doing. Real projects may be very big and contain hundreds of thousands lines of code. In this tutorial we are going to start with a simple three-line application that asks the user their name and greets them.
- In the Project tool window on the left, expand the node named after your project and open the /src/main/kotlin/main.kt file.
- The file only contains the main() function with print statements. This function is the entry point of your program. Replace the Hello World! sample with the following code snippet:
Now we have a working code that reads the username from the console, stores it in a read-only variable, and outputs a greeting using the stored value.
Run code from IntelliJ IDEA
Let’s verify that our program works as expected.
IntelliJ IDEA allows you to run applications right from the editor. You don’t need to worry about the technical aspect because IntelliJ IDEA automatically does all the necessary preparations behind the scenes.
- Click the Run icon in the gutter and select Run ‘MainKt’ or press Ctrl+Shift+F10 .
When the program has started, the Run tool window opens, where you can review the output and interact with the program.
Package as JAR
At this point, you know how to write code and run it from IntelliJ IDEA, which is convenient in the development process. However, this is not the way the users are supposed to run applications. For the users to run it on their computers, we are going to build and package the application as a jar file.
JAR is a file format for distributing applications as a single file.
Building the app includes the following steps:
- Compiling the sources – in this step, you translate the code you’ve just written into JVM bytecode. The compiled sources have the .class extension.
- Bundling the dependencies – for the application to function correctly, we need to provide the libraries it depends on. The only required library for this project is Kotlin runtime, but still, it needs to be included. Otherwise, the users will have to provide it themselves every time they run the program, which is not very convenient.
Both the compiled sources and the dependencies end up in the resulting .jar file. The result of the build process such as .jar file is called an artifact .
The instructions are provided for Gradle and Kotlin as DSL. To learn how to accomplish the same using other build tools, use the Build tool switcher at the top of the page.
The instructions are provided for Gradle and Groovy as DSL. To learn how to accomplish the same using other build tools, use the Build tool switcher at the top of the page.
The instructions are provided for Maven. To learn how to accomplish the same using other build tools, use the Build tool switcher at the top of the page.
The instructions are provided for IntelliJ IDEA build tool. To learn how to accomplish the same using other build tools, use the Build tool switcher at the top of the page.
- Open the build.gradle.kts build.gradle script. The build script is the file that tells the build tool how exactly to build the project. The build script is the file that tells the build tool how exactly to build the project. It is written in Kotlin just like the source code of your program.
- In the build script, add the following task definition:
tasks.jar < manifest < attributes["Main-Class"] = "MainKt" >configurations[«compileClasspath»].forEach < file: File ->from(zipTree(file.absoluteFile)) > duplicatesStrategy = DuplicatesStrategy.INCLUDE >
The manifest section specifies the entry point of the program, and the rest tells the build tool to recursively scan the project for dependencies and include them in the build.
The resulting JAR appears in the build/libs directory.
- Go to File | Project Structure Ctrl+Alt+Shift+S and open the Artifacts tab.
- Click Add , then JAR , then From modules with dependencies .
- In the Main Class field, click the Browse button, and select Main.kt as the main class. Specify the absolute path to /src/main/resources as the manifest directory, for example: /Users/me.user/IdeaProjects/greeting/src/main/resources
- Click OK in the Create JAR from Modules dialog.
- Click OK in the Project Structure dialog.
- From the main menu, select Build | Build Artifacts , then click Build .
The resulting JAR appears in the out/artifacts directory.
Run the JAR
Run from IntelliJ IDEA
- In the Project tool window, right-click the .jar file and select Run . This is a quick way to run a .jar file from IntelliJ IDEA.
Run from CLI
- Open the terminal and from the containing folder, run: java -jar consoleApp.jar java -jar greeting.jar java -jar greeting-1.0-SNAPSHOT.jar This is how the users of your application would run it. JDK 1.8 or later is required to run the .jar
Building Kotlin Libraries Sample
This guide demonstrates how to create a Kotlin library with Gradle using gradle init . You can follow the guide step-by-step to create a new project from scratch or download the complete sample project using the links above.
What you’ll build
You’ll generate a Kotlin library that follows Gradle’s conventions.
What you’ll need
- A text editor or IDE — for example IntelliJ IDEA
- A Java Development Kit (JDK), version 8 or higher — for example AdoptOpenJDK
- The latest Gradle distribution
Create a project folder
Gradle comes with a built-in task, called init , that initializes a new Gradle project in an empty folder. The init task uses the (also built-in) wrapper task to create a Gradle wrapper script, gradlew .
The first step is to create a folder for the new project and change directory into it.
Run the init task
From inside the new project directory, run the init task using the following command in a terminal: gradle init . When prompted, select the 3: library project type and 4: Kotlin as implementation language. Next you can choose the DSL for writing buildscripts — 1 : Groovy or 2: Kotlin . For the other questions, press enter to use the default values.
The output will look like this:
$ gradle init Select type of project to generate: 1: basic 2: application 3: library 4: Gradle plugin Enter selection (default: basic) [1..4] 3 Select implementation language: 1: C++ 2: Groovy 3: Java 4: Kotlin 5: Scala 6: Swift Enter selection (default: Java) [1..6] 4 Select build script DSL: 1: Groovy 2: Kotlin Enter selection (default: Groovy) [1..2] 1 Project name (default: demo): Source package (default: demo): BUILD SUCCESSFUL 2 actionable tasks: 2 executed
The init task generates the new project with the following structure:
├── gradle (1) │ └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew (2) ├── gradlew.bat (2) ├── settings.gradle.kts (3) └── lib ├── build.gradle.kts (4) └── src ├── main │ └── kotlin (5) │ └── demo │ └── Library.kt └── test └── kotlin (6) └── demo └── LibraryTest.kt
├── gradle (1) │ └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew (2) ├── gradlew.bat (2) ├── settings.gradle (3) └── lib ├── build.gradle (4) └── src ├── main │ └── kotlin (5) │ └── demo │ └── Library.kt └── test └── kotlin (6) └── demo └── LibraryTest.kt
1 | Generated folder for wrapper files |
2 | Gradle wrapper start scripts |
3 | Settings file to define build name and subprojects |
4 | Build script of lib project |
5 | Default Kotlin source folder |
6 | Default Kotlin test source folder |
You now have the project setup to build a Kotlin library.
Review the project files
The settings.gradle(.kts) file has two interesting lines:
rootProject.name = "demo" include("lib")