Skip to main content

🚀 Quick start

🤖 Using automated approach (Recommended)​

🚩 Pre-requisites​

Following are the pre-requisites for getting started via automated approach:

  • Node JS LTS: Download the latest v18 LTS from here.
  • Java: Download the latest Java JDK v17 from here.
  • Maven: Download the latest Maven distribution from here and follow the installation guide provided here.

âŦ‡ī¸ Install Boyka CLI​

To quickly get started, run the following command on the terminal to install the Boyka command line tool:

npm i -g @boykaframework/boyka-cli

✨ Create the Boyka project​

Once you have installed the Boyka command line assistant, run the following command on your terminal to create a minimalist Maven project:

boyka init [project-name]

Here, you can give any project name of your choosing.

When you execute this command, you will be asked a set of questions, based on which, the Boyka project will be setup.

tip

While answering the questions, make sure you read it carefully and reply accordingly to your requirement.

A new folder of the project name which you provided to the command will be created which you can open in any IDE of your choosing.

info

It is recommended to use IntelliJ IDEA for writing your test.

Open the newly created project in IntelliJ IDE and do a Maven refresh using the Maven Tab. Next, build the project using the Build menu, when prompted Enable Lombok Annotation Processing, click to enable it.

tip

If the project is set using Boyka CLI assistant and the sample tests have been generated, refer those tests for code walkthrough and write your own tests using it as an example.

đŸ’Ē Using manual approach​

✨ Create Maven project​

Use any IDE of your choosing and create a new Java Maven project using JDK 17.

You can also enforce the Java version in pom.xml file as shown below.

pom.xml
. . .
<properties>
  . . .
  <maven.compiler.source>17</maven.compiler.source>
  <maven.compiler.target>17</maven.compiler.target>
  . . .
</properties>

âŦ‡ī¸ Add Dependency​

info

Use the latest version from Maven Central and add it to your pom.xml