Skip to content

Commit

Permalink
fix(website): 🐛 updated docs and readme as per suggestion
Browse files Browse the repository at this point in the history
  • Loading branch information
WasiqB committed Oct 3, 2024
1 parent 78150aa commit 8ba66cb
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 17 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@

## 🖱️ One command Boyka project setup

First you need to install [Boyka command line assistant](https://github.com/BoykaFramework/boyka-cli) by running the following command:
Install [Boyka command line assistant](https://github.com/BoykaFramework/boyka-cli) by running the following command:

```shell
npm i -g @boykaframework/boyka-cli
Expand All @@ -56,10 +56,10 @@ Once it is installed, run the following command to setup Boyka project:
boyka init [project-name]
```

When you execute this command, you will be prompted by a set of questions which you must answer to setup the Boyka project with Maven and Java 17.
When this command is executed, multiple set of questions will be prompted that must be answered to setup the project. By default, the Boyka project uses Java 17 as programming language and Maven as the build tool.

> [!TIP]
> This will only take few seconds.
> Boyka CLI assistant will allow setting up the project quickly within seconds.
## 👜 Resources

Expand Down
21 changes: 8 additions & 13 deletions website/docs/framework-docs/getting-started/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ sidebar_position: 1
title: 🚀 Quick start
---

## 🤖 Using automated approach
## 🤖 Using automated approach (Recommended)

### 🚩 Pre-requisites

Expand Down Expand Up @@ -34,7 +34,7 @@ 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
Read the questions very carefully and understand it, then reply with your answers
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.
Expand All @@ -43,10 +43,10 @@ A new folder of the project name which you provided to the command will be creat
It is recommended to use IntelliJ IDEA for writing your test.
:::

When you open the newly created project in IntelliJ, first do Maven refresh in the Maven Tab, Then build the project from the `Build` menu, when prompted to `Enable Lombok Annotation processing`, click on that button. That's it!
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 you had selected to generate sample tests option in the `boyka init` command execution, then you can refer to the tests, how it is structured and what methods are being used, and create your own tests.
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
Expand All @@ -69,17 +69,12 @@ You can also enforce the Java version in `pom.xml` file as shown below.

### ⬇️ Add Dependency

Add the following dependency to your `pom.xml` file:

```xml title="pom.xml"
<dependency>
<groupId>io.github.boykaframework</groupId>
<artifactId>boyka-framework</artifactId>
<version>2.1.0</version>
</dependency>
```
:::info
Use the latest version from [Maven Central][maven-central] and add it to your `pom.xml`
:::

[jdk17]: https://adoptium.net/temurin/releases/
[maven]: https://maven.apache.org/install.html
[maven-download]: https://maven.apache.org/download.cgi
[node]: https://nodejs.org/en/download/package-manager
[maven-central]: https://mvnrepository.com/artifact/io.github.boykaframework/boyka-framework
2 changes: 1 addition & 1 deletion website/docs/framework-docs/intro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_position: 1

## What is Boyka Framework?

Boyka Framework is an open source Test Automation Framework written in Java, that helps you in automating Web, API, Android and iOS based applications with ease.
Boyka Framework is an open source Test Automation Framework written in Java that supports automating Web, API, and Mobile (Android and iOS applications) seamlessly.

## Why Boyka Framework was created?

Expand Down

0 comments on commit 8ba66cb

Please sign in to comment.