feat: shell to bash

Author: KTC-YoheiMiyashita

README.md

@@ -39,7 +39,7 @@ Spring Boot 2からの移行、または新規開発において、最新のバ
 ---
 
 ## 🗂️ Project Structure / プロジェクト構成
-```plaintext
+```bash
 .
 ├── dbAndCsvBatch       # DB to CSV and CSV to DB batch jobs
 │   ├── src
@@ -62,39 +62,141 @@ Spring Boot 2からの移行、または新規開発において、最新のバ
 - Docker for setting up the MySQL environment.
 
 ### 1.	Clone the repository
-```shell
+```bash
 git clone https://github.com/kinto-technologies/SpringBoot3BatchStarter.git
 ```
 
 ### 2. Build the skeleton batch
-```shell
+```bash
 cd skeletonBatch
 ../gradlew
 ```
 
 ### 3. Run the skeleton batch
-```shell
+```bash
 java -jar build/libs/skeletonBatch-*.jar
 ```
 
 ### 4. Set up the MySQL database for DB and CSV batch
-```shell
+```shell# Spring Batch3 Starter - Accelerate Your Spring Boot 3 Batch Development🚀
+
+## Overview / 概要
+
+This repository is a Spring Batch Starter Kit tailored for Spring Boot 3. It simplifies batch job development with the latest Spring Batch 5 features, ensuring compatibility with Spring Boot 3. Whether you’re upgrading from Spring Boot 2 or starting fresh, this project equips you to leverage the enhanced capabilities of Spring Batch.
+
+このリポジトリは Spring Boot 3 および Spring Batch 5 の最新機能を活用して、バッチ処理の開発を効率化するためのスターターキットです。
+Spring Boot 2からの移行、または新規開発において、最新のバッチ処理フレームワークをすぐに使い始めることができます。
+
+### Key Highlights
+- **Skeleton Batch Framework**: Quickly develop custom batch jobs with minimal setup.
+- **DB to CSV Batch**: Export data from MySQL to CSV files seamlessly.
+- **CSV to DB Batch**: Import CSV data into MySQL efficiently.
+
+### 主な特徴
+- **スケルトンバッチ**: 業務ロジックを追加するだけでバッチを簡単に構築可能。
+- **DB to CSVバッチ**: MySQLからCSVファイルへのデータ出力します。where句を実行時引数で指定可能。
+- **CSV to DBバッチ**: CSVデータをMySQLにバルクで登録します。
+
+---
+
+## 💡 Key Features / 特徴
+
+### 🚀 Batch Development Made Simple
+- **Spring Batch Framework**: Streamlined job and step management.
+- **JOOQ ORM**: SQL-like query writing and entity generation, eliminating boilerplate code.
+- **OpenCSV Integration**: Hassle-free CSV file handling.
+- **Multi-Database Support**: H2 for metadata management and MySQL for business data.
+
+### ⚙️ Flexibility and Optimization
+- **Dynamic Configurations**: Environment-specific setups with profiles (local/server).
+- **Customizable Batches**: Execute multiple jobs within a single JAR by passing runtime arguments.
+- **Google Java Format**: Automated code formatting with Spotless.
+
+### 💼 Future-Proof Design
+- **Skeleton Batch Framework**: A template for creating new batch jobs.
+- **Pre-configured Docker Environment**: Quickly set up a local MySQL database with Docker Compose.
+
+---
+
+## 🗂️ Project Structure / プロジェクト構成
+```bash
+.
+├── dbAndCsvBatch       # DB to CSV and CSV to DB batch jobs
+│   ├── src
+│   │   ├── main
+│   │   └── test
+│   ├── build.gradle    # Gradle configuration for dbAndCsvBatch module
+│   ├── compose.yaml    # Docker Compose file for MySQL container
+│   └── init-scripts    # SQL scripts to initialize the database
+└── skeletonBatch       # A skeleton batch example for future extensions
+    ├── src
+    │   ├── main
+    │   └── test
+    ├── build.gradle    # Gradle configuration for skeletonBatch module
+    └── README.md       # Detailed documentation for skeletonBatch
+```
+
+## 🚀 Getting Started / はじめに
+### Prerequisites
+- Java 17+ for Spring Boot 3.
+- Docker for setting up the MySQL environment.
+
+### 1.	Clone the repository
+```bash
+git clone https://github.com/kinto-technologies/SpringBoot3BatchStarter.git
+```
+
+### 2. Build the skeleton batch
+```bash
+cd skeletonBatch
+../gradlew
+```
+
+### 3. Run the skeleton batch
+```bash
+java -jar build/libs/skeletonBatch-*.jar
+```
+
+### 4. Set up the MySQL database for DB and CSV batch
+```bash
 cd ../dbAndCsvBatch
 docker compose up -d
 ```
 ### 5. Build the DB and CSV batch jobs
-```shell
+```bash
+cd ../dbAndCsvBatch
+../gradlew
+```
+
+### 6. Run Db to CSV Batch
+```bash
+java -jar build/libs/dbAndCsvBatch-*.jar --spring.batch.job.name=DB_TO_CSV --spring.profiles.active=local
+```
+
+### 7. Run CSV to DB Batch
+```bash
+java -jar build/libs/dbAndCsvBatch-*.jar --spring.batch.job.name=CSV_TO_DB --spring.profiles.active=local
+```
+
+#### With this Spring Batch Starter Kit, you can focus on your business logic while the framework handles the heavy lifting. Happy coding! 🎉
+```bash
+cd ../dbAndCsvBatch
+docker compose up -d
+```
+
+### 5. Build the DB and CSV batch jobs
+```bash
 cd ../dbAndCsvBatch
 ../gradlew
 ```
 
 ### 6. Run Db to CSV Batch
-```shell
+```bash
 java -jar build/libs/dbAndCsvBatch-*.jar --spring.batch.job.name=DB_TO_CSV --spring.profiles.active=local
 ```
 
 ### 7. Run CSV to DB Batch
-```shell
+```bash
 java -jar build/libs/dbAndCsvBatch-*.jar --spring.batch.job.name=CSV_TO_DB --spring.profiles.active=local
 ```
 

dbAndCsvBatch/README.md

@@ -1,70 +1,88 @@
-# dbAndCsvBatch / データベースとCSVのバッチ処理
+# dbAndCsvBatch - Database and CSV Batch Processing / データベースとCSVのバッチ処理 🚀
+
+This module provides practical batch processing samples for:
 
-This module provides sample batch processing implementations for:  
 このモジュールは以下のバッチ処理サンプルを提供します:
 1. Exporting data from a database to a CSV file (DB to CSV).  
    データベースからCSVファイルを生成します (DB to CSV)。
 2. Importing data from a CSV file into a database (CSV to DB).  
    CSVファイルからデータベースにデータを登録します (CSV to DB)。
 
-## Docker
-Note: If you cannot use Docker, please download and install Docker from Docker's official website.
-Follow the instructions provided for your operating system.
-
-注釈: Dockerコマンドが使用できない場合は、[Dockerの公式サイト](https://www.docker.com/get-started)からダウンロードしてインストールしてください。
+## 🐳 Docker Setup
+If Docker is not available, download it from the official Docker website. Follow the installation instructions for your operating system.
+注記: Dockerが使用できない場合は、Dockerの公式サイトからダウンロードし、手順に従ってインストールしてください。
 
 ## How to Run / 実行方法
+Steps:
+1. Navigate to the dbAndCsvBatch directory:
 ```bash
 cd dbAndCsvBatch
-
-## Local環境にMySQLコンテナを作成する  
-## Create a MySQL container for the local environment  
+```
+ 
+2. Build and run the MySQL container:
+```bash
 docker compose down && docker compose build && docker compose up -d
+```
 
-## MySQLコンテナに接続して、テーブルとレコードの確認  
-## Connect to the MySQL container and check tables and records  
+3. Connect to the MySQL container and verify the setup:
+```bash
 docker exec -it mysql-container mysql -u sampleuser -psamplepassword sampledb
 
 mysql> show databases;
+
 mysql> show tables;  
+
 mysql> SELECT * FROM member;  
+
 mysql> SELECT * FROM member WHERE delete_flag = 0 AND type IN (1, 2, 3) ORDER BY type ASC;
+
 mysql> exit;
+```
+## 💻 How to Run / 実行方法
 
-# DBからEntityクラスを生成した後に実行可能JARを作成するように、default taskを設定している  
-# Generate the JAR file by executing the default task after creating entity classes from the database  
+Step-by-Step Guide
+1. Generate the JAR file
+Execute the default task to generate the Spring Boot JAR file:
+```bash
 ../gradlew
+```
+	
+2. Verify Generated Files
+Confirm that the entity classes and JAR file were successfully created:
 
-# EntityクラスがDBから自動生成された事を確認
-# Verify that the Entity classes were generated from the database
+```bash
+# Check generated entity classes
 ls -R build/generated-src/jooq
 
-# spring boot jarファイルが生成されていることを確認  
-# Verify that the Spring Boot JAR file has been generated  
+# Verify the generated Spring Boot JAR
 ls -ls build/libs/dbAndCsvBatch-*.jar
+```
 
-
-## for local  
-## DBからCSVファイルを生成するバッチを起動  
-## Run the batch job to generate a CSV file from the database  
+3. Run Batch Jobs
+### For Local Environment
+- Export data from DB to CSV:
+```bash
 java -jar build/libs/dbAndCsvBatch-*.jar --spring.batch.job.name=DB_TO_CSV --spring.profiles.active=local
+```
 
-## 実行時引数を指定してバッチを起動する場合
-## When invoking a batch with runtime arguments
+- Run batch with custom runtime arguments:
+```bash
 java -jar build/libs/dbAndCsvBatch-*.jar --spring.batch.job.name=DB_TO_CSV --batch.types=2,4 --spring.profiles.active=local
+```
 
-## CSVファイルからDBに登録するバッチを起動  
-## Run the batch job to import data from a CSV file into the database  
+- Import data from CSV to DB:
+```bash
 java -jar build/libs/dbAndCsvBatch-*.jar --spring.batch.job.name=CSV_TO_DB --spring.profiles.active=local
+```
 
----- 
-
-## for server  
-## DBからCSVファイルを生成するバッチを起動  
-## Run the batch job to generate a CSV file from the database  
+### For Server Environment
+- Export data from DB to CSV:
+```bash
 java -jar build/libs/dbAndCsvBatch-*.jar --spring.batch.job.name=DB_TO_CSV --spring.profiles.active=server
+```
 
-## CSVファイルからDBに登録するバッチを起動  
-## Run the batch job to import data from a CSV file into the database  
+- Import data from CSV to DB:
+```bash
 java -jar build/libs/dbAndCsvBatch-*.jar --spring.batch.job.name=CSV_TO_DB --spring.profiles.active=server
 ```
+With this module, you can seamlessly integrate database and CSV operations into your Spring Boot batch applications. Happy coding! 🎉

skeletonBatch/README.md

@@ -1,27 +1,31 @@
-# Skeleton Batch - Spring Batch Template
+# Skeleton Batch - Spring Batch Template 🚀
 
-## Overview / 概要
-The skeletonBatch module is a simple and efficient template for creating custom batch jobs using Spring Batch.
-By adding your own business logic, you can quickly complete a fully functional Spring Boot 3 batch application.
+## Overview / 概要 🌟
 
-skeletonBatch モジュールは、Spring Batch を使用してカスタムバッチジョブを簡単かつ効率的に作成するためのテンプレートです。
-業務ロジックを追加するだけで、完成されたSpring Boot 3バッチアプリケーションを素早く構築できます。
+The skeletonBatch module is a streamlined template designed to help you create custom batch jobs effortlessly with Spring Batch.
+Simply add your business logic, and you’ll have a fully operational Spring Boot 3 batch application in no time.
 
+SkeletonBatch モジュールは、Spring Batch を使って簡単かつ効率的にカスタムバッチジョブを作成するためのテンプレートです。
+業務ロジックを追加するだけで、すぐに動作する Spring Boot 3 バッチアプリケーションを構築できます。
 ---
 
-## How to Run / 実行方法
+## How to Run / 実行方法 🔧
+
+Step-by-step Instructions
 ```bash
+# Navigate to the skeletonBatch directory
 cd skeletonBatch
 
-# 実行可能JARを作成するように、default taskを設定している  
-# Generate the JAR file by executing the default task.  
+# Execute the default task to generate the JAR file
 ../gradlew
 
-# spring boot jarファイルが生成されていることを確認  
-# Verify that the Spring Boot JAR file has been generated  
+# Confirm that the Spring Boot JAR file has been generated
 ls -ls build/libs/skeletonBatch-*.jar
 
-## スケルトンのバッチを起動  
-## Run the batch job to skeleton  
+# Run the skeleton batch application
 java -jar build/libs/skeletonBatch-*.jar
 ```
+## Highlights / 特徴 ✨
+- Simple Setup: Pre-configured tasks for quick builds.
+- Fast Execution: Minimal effort to start your batch job.
+- Customizable: Extend the template with your business logic.