Skip to content

Commit a3b3982

Browse files
fix: README
1 parent 68a7167 commit a3b3982

File tree

2 files changed

+27
-17
lines changed

2 files changed

+27
-17
lines changed

README.ja.md

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,47 +9,53 @@
99
![Java 21](https://img.shields.io/badge/Java-21%2B-blue)
1010
[![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-CC2233.svg)](https://opensource.org/licenses/Apache-2.0)
1111

12-
## 🔍 Overview
12+
## 🇬🇧 English
13+
14+
The English version of the README can be found [here](README.md).
15+
16+
## 🔍 概要
1317

1418
このリポジトリは、**Spring Boot 3****Spring Batch 5** のために特化した**Spring Batchスターターキット**です。
1519
最新機能を活用し、Spring Boot 3との完全な互換性を持つことで、バッチジョブ開発を効率化します。
1620
**Spring Boot 2** からの移行や新規プロジェクトで、**Spring Batchの強化された機能**を簡単に活用できます。
1721

18-
### 📝 Key Highlights
22+
### 📝 主な特徴
1923
- **スケルトンバッチフレームワーク**: 最小限の設定でカスタムバッチジョブを簡単に開発できます。
2024
- **DB to CSV バッチ**: MySQLデータをCSVファイルにエクスポート。動的なWHERE句や柔軟な出力設定に対応しています。
2125
- **CSV to DB バッチ**: CSVデータをMySQLに効率的にインポートします。バルク処理とエラーハンドリング機能を備えています。
2226

23-
### 再利用性
24-
このキットは非常に適応性があります。データベース接続設定を更新し、CSVのカラム定義を業務要件に合わせて変更するだけで、すぐにプロジェクトに利用できます。
27+
### ♻️ 再利用性
28+
このキットは非常に柔軟で、データベース接続設定を変更し、CSVのカラム定義を業務要件に合わせるだけで、すぐにプロジェクトに利用できます。
2529

2630
---
2731

2832

2933

3034
## 💡 特徴
3135

32-
### Batch Development Made Simple
36+
### バッチ開発を簡単に
3337
- **Spring Batch フレームワーク**: ジョブとステップの管理を効率化。
34-
- **JOOQ ORM**: SQLライクなクエリ記述とエンティティ生成機能。
35-
- **OpenCSV 統合**: CSVファイルの簡単な取り扱い。
38+
- **jooq ORM**: SQLライクなクエリ記述とエンティティ生成機能。
39+
- **OpenCSV**: CSVファイルの簡単な取り扱い。
3640
- **マルチデータベースサポート**:
3741
- H2 : バッチメタデータ管理にH2
3842
- MySQL : 業務データ処理にMySQL
3943

4044
### 柔軟性と最適化
4145
- **動的な設定**: 環境ごとの設定(ローカル/サーバー)をプロファイルで管理。
42-
- **カスタマイズ可能なバッチ**: 実行時の引数で複数のジョブを動的に実行。
46+
- **複数ジョブの動的実行**: 実行時の引数で複数のジョブを動的に実行。
47+
- **カスタマイズ可能なバッチ**: 実行時の引数により、バッチ内のクエリのWHERE句を動的に変更。
4348
- **Google Java Format**: Spotlessを使用した自動コード整形。
49+
- **品質チェックとカバレッジ**: Spotbugsによる静的解析、Jacocoによるテストカバレッジの生成、CIツールでのチェック。
4450

4551
### 将来に向けた設計
46-
- **スケルトンバッチフレームワーク**: 事前設定されたDocker環境
47-
- **事前設定されたDocker環境**: ローカルのMySQLデータベースを迅速にセットアップ
48-
- **CI/CD**: Github Actions で継続的インテグレーションと継続的デリバリーを実現。
52+
- **スケルトンバッチフレームワーク**: バッチジョブを迅速に開発できる事前設定されたテンプレート
53+
- **Docker環境設定**: ローカルのMySQLデータベースを簡単にセットアップできる`compose.yaml`ファイルを提供
54+
- **CI/CD**: Github Actions で 継続的インテグレーションと継続的デリバリーを実現。
4955

5056
---
5157

52-
## 🗂️ プロジェクト概要
58+
## 🗂️ プロジェクト構成
5359
```text
5460
.
5561
├── gradlew
@@ -113,10 +119,12 @@ java -jar build/libs/dbAndCsvBatch-*.jar --spring.batch.job.name=CSV_TO_DB --spr
113119

114120
> **注意**: ステップ4を実行する前にDockerがインストールされていて、実行中であることを確認してください。
115121
116-
#### 🎉 このSpring Batchスターターキットを使えば、フレームワークが重い作業を引き受ける間に、あなたはビジネスロジックに集中できます。
122+
123+
#### 🎉 このSpring Batchスターターキットを使用すれば、すでに土台が構築されているので、ビジネスロジックに集中できます。
117124
**楽しいコーディングを!** 🚀
118125

119126
## 📄 ライセンス
120127

121128
このプロジェクトは、**[Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0)** の下でライセンスされています。
129+
122130
Copyright © 2024 KINTO Technologies Corporation

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Whether you’re upgrading from **Spring Boot 2** or starting a new project, thi
2222
- **DB to CSV Batch**: Export data from MySQL to CSV files seamlessly, with runtime arguments for dynamic WHERE clauses and flexible output configurations.
2323
- **CSV to DB Batch**: Import CSV data into MySQL efficiently with bulk operations and error handling.
2424

25-
### Reusability / 再利用性
25+
### ♻️ Reusability
2626

2727
This kit is highly adaptable. By simply updating the database connection settings and modifying the CSV column definitions to match your specific business needs, you can immediately start using it for your projects.
2828

@@ -42,12 +42,14 @@ This kit is highly adaptable. By simply updating the database connection setting
4242

4343
### Flexibility and Optimization
4444
- **Dynamic Configurations**: Environment-specific setups with profiles (local/server).
45-
- **Customizable Batches**: Execute multiple jobs dynamically with runtime arguments.
45+
- **Dynamic Execution of Multiple Jobs**: Execute multiple jobs dynamically with runtime arguments.
46+
- **Customizable Batches**: Modify WHERE clauses of queries inside batches dynamically based on runtime arguments.
4647
- **Google Java Format**: Automated code formatting with Spotless.
48+
- **Quality Checks and Coverage**: Static analysis with Spotbugs, test coverage generation with Jacoco, and CI tools for checks.
4749

4850
### Future-Proof Design
49-
- **Skeleton Batch Framework**: A template for creating new batch jobs.
50-
- **Pre-configured Docker Environment**: Quickly set up a local MySQL database.
51+
- **Skeleton Batch Framework**: A pre-configured template for quickly developing batch jobs.
52+
- **Docker Environment Setup**: Provides a `compose.yaml` file to easily set up a local MySQL database.
5153
- **CI/CD**: Achieve Continuous Integration and Continuous Delivery with Github Actions.
5254

5355
---

0 commit comments

Comments
 (0)