Skip to content

Commit 9322939

Browse files
fix readme
1 parent c386d27 commit 9322939

File tree

2 files changed

+45
-36
lines changed

2 files changed

+45
-36
lines changed

README.ja.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,9 @@ Spring Boot 3 と Spring Batch 5 を使用した、すぐに使えるバッチ
2020

2121
> 💡 JDK 21が必要ですが、Gradleのツールチェーン機能により、ローカルにインストールされていなくても自動的にダウンロードされます。
2222
23-
## 1. スケルトンバッチを試す
23+
## 🚀 クイックスタート
24+
25+
### 1️⃣ スケルトンバッチを試す
2426
```bash
2527
# リポジトリのクローン
2628
git clone https://github.com/kinto-technologies/SpringBoot3BatchStarter.git
@@ -31,7 +33,7 @@ cd skeletonBatch
3133
java -jar build/libs/skeletonBatch-*.jar
3234
```
3335

34-
## 2. DBとCSVのバッチを試す
36+
### 2️⃣ DBとCSVのバッチを試す
3537

3638
```bash
3739
# MySQLコンテナの起動

README.md

Lines changed: 41 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,14 @@
2323

2424
This comprehensive starter kit is designed specifically for Spring Boot 3 and Spring Batch 5, providing a production-ready foundation for enterprise batch processing applications. It offers two main components:
2525

26-
## Skeleton Batch
26+
### Skeleton Batch
2727
A minimal, ready-to-use batch application where you can:
2828

2929
- Start development immediately by adding your business logic
3030
- Focus on implementation without complex configuration
3131
- Run in any environment with H2 in-memory database
3232

33-
## DB and CSV Batch
33+
### DB and CSV Batch
3434
A practical example implementing common batch operations:
3535

3636
- Export data from database to CSV with customizable queries
@@ -41,7 +41,7 @@ Both components are built with industry best practices and utilize the latest Sp
4141

4242
## 🚀 Quick Start Guide
4343

44-
### 1. Try Skeleton Batch
44+
### 1️⃣ Try Skeleton Batch
4545
```bash
4646
# Clone repository
4747
git clone https://github.com/kinto-technologies/SpringBoot3BatchStarter.git
@@ -52,8 +52,7 @@ cd skeletonBatch
5252
java -jar build/libs/skeletonBatch-*.jar
5353
```
5454

55-
### 2. Try DB and CSV Batch
56-
55+
### 2️⃣ Try DB and CSV Batch
5756
```bash
5857
# Start MySQL container
5958
cd ..
@@ -75,15 +74,15 @@ java -jar build/libs/dbAndCsvBatch-*.jar --spring.batch.job.name=CSV_TO_DB --spr
7574
.
7675
├── gradlew # Gradle wrapper
7776
├── settings.gradle
78-
├── compose.yaml # Docker Compose configuration
79-
├── init-scripts # Database initialization
77+
├── compose.yaml # Docker Compose configuration
78+
├── init-scripts # Database initialization
8079
│ ├── 1-create-table.sql
8180
│ └── 2-insert-data.sql
82-
├── dbAndCsvBatch # DB-CSV batch project
81+
├── dbAndCsvBatch # DB-CSV batch project
8382
│ ├── README.md
8483
│ ├── build.gradle
8584
│ └── src/
86-
└── skeletonBatch # Skeleton batch project
85+
└── skeletonBatch # Skeleton batch project
8786
├── README.md
8887
├── build.gradle
8988
└── src/
@@ -92,39 +91,47 @@ java -jar build/libs/dbAndCsvBatch-*.jar --spring.batch.job.name=CSV_TO_DB --spr
9291
## 💡 Core Features
9392

9493
### 🏗️ Foundation Components
95-
- **Production-Ready Batch Framework**
96-
- Pre-configured skeleton structure
97-
- Ready for immediate development
98-
- H2 in-memory database for simple setup
94+
- **Production-Ready Batch Framework**:
95+
- Pre-configured skeleton structure
96+
- Ready for immediate development
97+
- H2 in-memory database for simple setup
9998

10099
### 🔄 Data Operations
101-
- **DB to CSV Export**
102-
- Dynamic query support
103-
- Configurable data extraction
104-
- **CSV to DB Import**
105-
- Bulk insert operations
106-
- High-performance data loading
100+
- **DB to CSV Export**:
101+
- Dynamic query support
102+
- Configurable data extraction
103+
- **CSV to DB Import**:
104+
- Bulk insert operations
105+
- High-performance data loading
107106

108107
### 🛠️ Technical Stack
109-
- **Spring Integration**
110-
- Spring Batch job/step management
111-
- Type-safe SQL with jOOQ
112-
- CSV processing with OpenCSV
113-
- **Dual Database Setup**
114-
- H2 for batch metadata
115-
- MySQL for business data
108+
- **Spring Integration**:
109+
- Spring Batch job/step management
110+
- Type-safe SQL with jOOQ
111+
- CSV processing with OpenCSV
112+
- **Dual Database Setup**:
113+
- H2 for batch metadata
114+
- MySQL for business data
116115

117116
### 💻 Development Tools
118-
- **Dynamic Configuration**
119-
- Environment profiles (local/server)
120-
- Runtime job configuration
121-
- Customizable queries
117+
- **Dynamic Configuration**:
118+
- Environment profiles (local/server)
119+
- Runtime job configuration
120+
- Customizable queries
121+
- **Development Support**:
122+
- Hot reload support
123+
- Debug configuration
124+
- IDE integration
122125

123126
### 🔍 Quality Assurance
124-
- Google Java Format (Spotless)
125-
- Static analysis (SpotBugs)
126-
- Test coverage (Jacoco)
127-
- GitHub Actions CI pipeline
127+
- **Code Quality**:
128+
- Google Java Format (Spotless)
129+
- Static analysis (SpotBugs)
130+
- Test coverage (Jacoco)
131+
- **CI Pipeline**:
132+
- GitHub Actions integration
133+
- Automated testing
134+
- Quality gates
128135

129136
## ❓ Troubleshooting
130137

0 commit comments

Comments
 (0)