Skip to content

Commit 8ef3230

Browse files
Update README.md
1 parent b04a01e commit 8ef3230

File tree

1 file changed

+30
-26
lines changed

1 file changed

+30
-26
lines changed

README.md

Lines changed: 30 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,26 @@
1-
Spring Batch3 Starter - Accelerate Your Spring Boot 3 Batch Development🚀
2-
=============================
1+
# Spring Batch3 Starter
2+
3+
**Accelerate Your Spring Boot 3 Batch Development** 🚀
4+
5+
36
[![GitHub stars](https://img.shields.io/github/stars/KTC-YoheiMiyashita/SpringBoot3BatchStarter?style=social)](https://github.com/KTC-YoheiMiyashita/SpringBoot3BatchStarter/stargazers)
47
[![Build](https://github.com/kinto-technologies/SpringBoot3BatchStarter/actions/workflows/build.yml/badge.svg)](https://github.com/kinto-technologies/SpringBoot3BatchStarter/actions/workflows/build.yml)
58
![Java 21](https://img.shields.io/badge/Java-21%2B-blue)
69
[![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-CC2233.svg)](https://opensource.org/licenses/Apache-2.0)
710

8-
# SpringBoot3BatchStarter
9-
10-
## Overview / 概要
11+
## 🔍 Overview / 概要
1112

12-
This repository serves as a Spring Batch Starter Kit, specifically tailored for Spring Boot 3 and Spring Batch 5. It streamlines batch job development by leveraging the latest features and ensuring full compatibility with Spring Boot 3. Whether you’re upgrading from Spring Boot 2 or starting a new project, this starter kit enables you to harness the enhanced capabilities of Spring Batch with ease.
13+
This repository serves as a **Spring Batch Starter Kit**, specifically tailored for **Spring Boot 3** and **Spring Batch 5**. It streamlines batch job development by leveraging the **latest features** and ensuring full compatibility with Spring Boot 3.
14+
Whether you’re upgrading from **Spring Boot 2** or starting a new project, this starter kit enables you to **harness the enhanced capabilities** of Spring Batch with ease.
1315

1416
このリポジトリは、Spring Boot 3 と Spring Batch 5 の最新機能を活用して、バッチ処理開発を効率化するためのスターターキットです。動作する事が保証されたテンプレート上に業務ロジックを追加するだけで、簡単にバッチ処理を構築できます。Spring Boot 2 からの移行や新規プロジェクトにおいて、すぐに最新のバッチフレームワークを活用できます。
1517

16-
### Key Highlights
18+
### 📝 Key Highlights / 主な特徴
1719
- **Skeleton Batch Framework**: Quickly develop custom batch jobs with minimal setup.
1820
- **DB to CSV Batch**: Export data from MySQL to CSV files seamlessly, with runtime arguments for dynamic WHERE clauses and flexible output configurations.
1921
- **CSV to DB Batch**: Import CSV data into MySQL efficiently with bulk operations and error handling.
2022

21-
### 主な特徴
23+
2224
- **スケルトンバッチ**: 業務ロジックを追加するだけでバッチを簡単に構築する事が可能です。
2325
- **DB to CSVバッチ**: MySQLデータをCSVファイルに簡単に出力できます。実行時引数を利用した動的なWHERE句や柔軟な出力設定に対応しています。
2426
- **CSV to DBバッチ**: CSVデータをMySQLに効率的に取り込みます。バルク処理機能を備えています。
@@ -31,23 +33,26 @@ DB接続設定やCSVのカラム定義を業務仕様に合わせて変更する
3133

3234
---
3335

36+
37+
3438
## 💡 Key Features / 特徴
3539

36-
### 🚀 Batch Development Made Simple
40+
### Batch Development Made Simple
3741
- **Spring Batch Framework**: Streamlined job and step management.
38-
- **JOOQ ORM**: SQL-like query writing and entity generation, eliminating boilerplate code.
42+
- **JOOQ ORM**: SQL-like query writing and entity generation.
3943
- **OpenCSV Integration**: Hassle-free CSV file handling.
4044
- **Multi-Database Support**:
4145
- H2 In-Memory Database: Used for batch metadata management.
4246
- MySQL Database: Used for business data processing.
43-
### ⚙️ Flexibility and Optimization
47+
48+
### Flexibility and Optimization
4449
- **Dynamic Configurations**: Environment-specific setups with profiles (local/server).
45-
- **Customizable Batches**: Execute multiple jobs within a single JAR by passing runtime arguments.
50+
- **Customizable Batches**: Execute multiple jobs dynamically with runtime arguments.
4651
- **Google Java Format**: Automated code formatting with Spotless.
4752

48-
### 💼 Future-Proof Design
53+
### Future-Proof Design
4954
- **Skeleton Batch Framework**: A template for creating new batch jobs.
50-
- **Pre-configured Docker Environment**: Quickly set up a local MySQL database with Docker Compose.
55+
- **Pre-configured Docker Environment**: Quickly set up a local MySQL database.
5156

5257
---
5358

@@ -74,33 +79,30 @@ DB接続設定やCSVのカラム定義を業務仕様に合わせて変更する
7479
└── test
7580
```
7681

77-
## 🚀 Getting Started / はじめに
78-
### Prerequisites
79-
- Java 21+ for Spring Boot 3.
80-
- Docker for setting up the MySQL environment.
82+
## 🛠️ Getting Started / はじめに
8183

8284
### 1. Clone the repository
8385
```bash
8486
git clone https://github.com/kinto-technologies/SpringBoot3BatchStarter.git
8587
```
8688

87-
### 2. Build the skeleton batch
89+
### 2. Build the Skeleton Batch
8890
```bash
8991
cd skeletonBatch
9092
../gradlew
9193
```
9294

93-
### 3. Run the skeleton batch
95+
### 3. Run the Skeleton Batch
9496
```bash
9597
java -jar build/libs/skeletonBatch-*.jar
9698
```
9799

98-
### 4. Set up the MySQL database for DB and CSV batch
100+
### 4. Set up MySQL database (Docker)
99101
```bash
100102
docker compose up -d
101103
```
102104

103-
### 5. Build the DB and CSV batch jobs
105+
### 5. Build the DB and CSV Batch jobs
104106
```bash
105107
cd ../dbAndCsvBatch
106108
../gradlew
@@ -116,10 +118,12 @@ java -jar build/libs/dbAndCsvBatch-*.jar --spring.batch.job.name=DB_TO_CSV --spr
116118
java -jar build/libs/dbAndCsvBatch-*.jar --spring.batch.job.name=CSV_TO_DB --spring.profiles.active=local
117119
```
118120

119-
#### With this Spring Batch Starter Kit, you can focus on your business logic while the framework handles the heavy lifting. Happy coding! 🎉
121+
> **Note**: Ensure Docker is installed and running before executing step 4.
120122
121-
## License / ライセンス
123+
#### 🎉 **With this Spring Batch Starter Kit, you can focus on your business logic while the framework handles the heavy lifting.**
124+
**Happy coding!** 🚀
122125

123-
Copyright 2024 KINTO Technologies Corporation
126+
## 📄 License / ライセンス
124127

125-
This project is licensed under the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0).
128+
This project is licensed under the **[Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0)**.
129+
Copyright © 2024 KINTO Technologies Corporation

0 commit comments

Comments
 (0)