Skip to content

Commit

Permalink
fix readme
Browse files Browse the repository at this point in the history
  • Loading branch information
diegolagospagopa authored Jan 9, 2025
1 parent 1369888 commit d325d13
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,40 +28,41 @@ Here is a quick overview of the files and directories included in this repositor
## 🚀 Features

### 📜 OpenAPI

- Example OpenAPI specification file (`template-payments-java-repository.openapi.yaml`) to document your RESTful APIs.
- Compatible with tools like Swagger and Postman.

### ⚙️ Helm

- Template Helm charts for deploying your Java application on Kubernetes.
- Includes `values.yaml` for parameter configuration and pre-defined deployment manifests.

### 🔧 Gradle

- `build.gradle` file with dependencies and plugins for building, testing, and running your Java application.
- Compatible with Java 21+.

### ☕ Java

- Example Java application structure with a simple `HelloWorld` class.

### ✅ JUnit

- Example JUnit test cases under the `test/` directory to help you get started with unit testing.

---

## 🛠️ Getting Started

### Prerequisites

Ensure the following tools are installed on your machine:

1. **Java 21+**
2. **Gradle** (or use the Gradle wrapper included in the repository)
3. **Docker** (for Helm-related tasks, optional)

### Building

#### Build

```sh
./gradlew clean build
```
### Building & Run

#### Build

Expand All @@ -75,7 +76,6 @@ Ensure the following tools are installed on your machine:
./gradlew bootRun
```


#### Write Locks

```sh
Expand Down

0 comments on commit d325d13

Please sign in to comment.