Skip to content

Commit 25eba70

Browse files
Update README.md
1 parent 5939317 commit 25eba70

File tree

1 file changed

+1
-81
lines changed

1 file changed

+1
-81
lines changed

README.md

Lines changed: 1 addition & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -77,90 +77,10 @@ cd skeletonBatch
7777
java -jar build/libs/skeletonBatch-*.jar
7878
```
7979

80-
### 4. Set up the MySQL database for DB and CSV batch
81-
```shell# Spring Batch3 Starter - Accelerate Your Spring Boot 3 Batch Development🚀
82-
83-
## Overview / 概要
84-
85-
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.
86-
87-
このリポジトリは Spring Boot 3 および Spring Batch 5 の最新機能を活用して、バッチ処理の開発を効率化するためのスターターキットです。
88-
Spring Boot 2からの移行、または新規開発において、最新のバッチ処理フレームワークをすぐに使い始めることができます。
89-
90-
### Key Highlights
91-
- **Skeleton Batch Framework**: Quickly develop custom batch jobs with minimal setup.
92-
- **DB to CSV Batch**: Export data from MySQL to CSV files seamlessly.
93-
- **CSV to DB Batch**: Import CSV data into MySQL efficiently.
94-
95-
### 主な特徴
96-
- **スケルトンバッチ**: 業務ロジックを追加するだけでバッチを簡単に構築可能。
97-
- **DB to CSVバッチ**: MySQLからCSVファイルへのデータ出力します。where句を実行時引数で指定可能。
98-
- **CSV to DBバッチ**: CSVデータをMySQLにバルクで登録します。
99-
100-
---
101-
102-
## 💡 Key Features / 特徴
103-
104-
### 🚀 Batch Development Made Simple
105-
- **Spring Batch Framework**: Streamlined job and step management.
106-
- **JOOQ ORM**: SQL-like query writing and entity generation, eliminating boilerplate code.
107-
- **OpenCSV Integration**: Hassle-free CSV file handling.
108-
- **Multi-Database Support**: H2 for metadata management and MySQL for business data.
109-
110-
### ⚙️ Flexibility and Optimization
111-
- **Dynamic Configurations**: Environment-specific setups with profiles (local/server).
112-
- **Customizable Batches**: Execute multiple jobs within a single JAR by passing runtime arguments.
113-
- **Google Java Format**: Automated code formatting with Spotless.
114-
115-
### 💼 Future-Proof Design
116-
- **Skeleton Batch Framework**: A template for creating new batch jobs.
117-
- **Pre-configured Docker Environment**: Quickly set up a local MySQL database with Docker Compose.
118-
119-
---
120-
121-
## 🗂️ Project Structure / プロジェクト構成
122-
```bash
123-
.
124-
├── dbAndCsvBatch # DB to CSV and CSV to DB batch jobs
125-
│   ├── src
126-
│   │   ├── main
127-
│   │   └── test
128-
│   ├── build.gradle # Gradle configuration for dbAndCsvBatch module
129-
│   ├── compose.yaml # Docker Compose file for MySQL container
130-
│   └── init-scripts # SQL scripts to initialize the database
131-
└── skeletonBatch # A skeleton batch example for future extensions
132-
├── src
133-
│   ├── main
134-
│   └── test
135-
├── build.gradle # Gradle configuration for skeletonBatch module
136-
└── README.md # Detailed documentation for skeletonBatch
137-
```
138-
139-
## 🚀 Getting Started / はじめに
140-
### Prerequisites
141-
- Java 17+ for Spring Boot 3.
142-
- Docker for setting up the MySQL environment.
143-
144-
### 1. Clone the repository
145-
```bash
146-
git clone https://github.com/kinto-technologies/SpringBoot3BatchStarter.git
147-
```
148-
149-
### 2. Build the skeleton batch
150-
```bash
151-
cd skeletonBatch
152-
../gradlew
153-
```
154-
155-
### 3. Run the skeleton batch
156-
```bash
157-
java -jar build/libs/skeletonBatch-*.jar
158-
```
159-
16080
### 4. Set up the MySQL database for DB and CSV batch
16181
```bash
16282
cd ../dbAndCsvBatch
163-
docker compose up -d
83+
docker compose up -d # Detailed documentation for skeletonBatch
16484
```
16585

16686
### 5. Build the DB and CSV batch jobs

0 commit comments

Comments
 (0)