Skip to content

Commit d4f3d33

Browse files
committed
docs: simplify README and add MinIO to tech stack
- Add Podman Desktop as alternative to Docker for local infrastructure - Remove redundant individual installation commands (use mise run install) - Rename design-token:build to tokens:build for brevity - Add MinIO section to WHY docs (S3 compatible object storage)
1 parent dc88940 commit d4f3d33

5 files changed

Lines changed: 23 additions & 35 deletions

File tree

README.ko.md

Lines changed: 4 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ npm create fullstack-starter my-app
9494
### 사전 요구사항
9595

9696
- [mise](https://mise.jdx.dev/) - 런타임 버전 관리자
97-
- [Docker](https://www.docker.com/) - 로컬 인프라 구동
97+
- [Docker](https://www.docker.com/) 또는 [Podman Desktop](https://podman-desktop.io/downloads) - 로컬 인프라 구동
9898
- [Terraform](https://www.terraform.io/) - 클라우드 인프라 (선택 사항)
9999

100100
### 1. 런타임 설치
@@ -110,21 +110,8 @@ mise install
110110
### 2. 의존성 설치
111111

112112
```bash
113-
# 모든 의존성 일괄 설치 (권장)
113+
# 모든 의존성 일괄 설치
114114
mise run install
115-
116-
# 또는 개별 설치
117-
# 웹 의존성 (JS/TS)
118-
cd apps/web && pnpm install
119-
120-
# API 의존성
121-
cd apps/api && uv sync --frozen
122-
123-
# 워커 의존성
124-
cd apps/worker && uv sync --frozen
125-
126-
# 모바일 의존성
127-
cd apps/mobile && flutter pub get
128115
```
129116

130117
### 3. 로컬 인프라 실행
@@ -195,7 +182,7 @@ mise tasks --all
195182
| `mise test` | 전체 앱 테스트 실행 |
196183
| `mise typecheck` | 타입 체크 |
197184
| `mise i18n:build` | 다국어 파일 빌드 |
198-
| `mise design-token:build` | 디자인 토큰 빌드 |
185+
| `mise tokens:build` | 디자인 토큰 빌드 |
199186
| `mise gen:api` | OpenAPI 스키마 및 클라이언트 생성 |
200187
| `mise infra:up` | 로컬 인프라 시작 |
201188
| `mise infra:down` | 로컬 인프라 중지 |
@@ -329,7 +316,7 @@ mise i18n:build
329316
packages/design-tokens/src/tokens.ts
330317

331318
# 빌드 및 배포
332-
mise design-token:build
319+
mise tokens:build
333320
# 생성 파일:
334321
# - apps/web/src/app/[locale]/tokens.css (CSS 변수)
335322
# - apps/mobile/lib/core/theme/generated_theme.dart (Flutter 테마)

README.md

Lines changed: 4 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ Or use GitHub:
9494
### Prerequisites
9595

9696
- [mise](https://mise.jdx.dev/) - Runtime version manager
97-
- [Docker](https://www.docker.com/) - Local infrastructure
97+
- [Docker](https://www.docker.com/) or [Podman Desktop](https://podman-desktop.io/downloads) - Local infrastructure
9898
- [Terraform](https://www.terraform.io/) - Cloud infrastructure (optional)
9999

100100
### 1. Install Runtimes
@@ -110,21 +110,8 @@ mise install
110110
### 2. Install Dependencies
111111

112112
```bash
113-
# Install all dependencies at once (recommended)
113+
# Install all dependencies at once
114114
mise run install
115-
116-
# Or install individually
117-
# Web dependencies (JS/TS)
118-
cd apps/web && pnpm install
119-
120-
# API dependencies
121-
cd apps/api && uv sync --frozen
122-
123-
# Worker dependencies
124-
cd apps/worker && uv sync --frozen
125-
126-
# Mobile dependencies
127-
cd apps/mobile && flutter pub get
128115
```
129116

130117
### 3. Start Local Infrastructure
@@ -195,7 +182,7 @@ mise tasks --all
195182
| `mise test` | Test all apps |
196183
| `mise typecheck` | Type check |
197184
| `mise i18n:build` | Build i18n files |
198-
| `mise design-token:build` | Build design tokens |
185+
| `mise tokens:build` | Build design tokens |
199186
| `mise gen:api` | Generate OpenAPI schema and API clients |
200187
| `mise infra:up` | Start local infrastructure |
201188
| `mise infra:down` | Stop local infrastructure |
@@ -329,7 +316,7 @@ mise i18n:build
329316
packages/design-tokens/src/tokens.ts
330317

331318
# Build and distribute
332-
mise design-token:build
319+
mise tokens:build
333320
# Generated files:
334321
# - apps/web/src/app/[locale]/tokens.css (CSS variables)
335322
# - apps/mobile/lib/core/theme/generated_theme.dart (Flutter Theme)

docs/WHY.ko.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,13 @@
7979
- **데이터 영속성**: RDB 스냅샷 및 AOF 로그를 통한 데이터 보존 옵션 제공
8080
- **클러스터링**: 대규모 트래픽 처리를 위한 수평 확장 지원
8181

82+
### MinIO
83+
84+
- **S3 호환성**: AWS S3 API와 완전 호환되어 프로덕션 Cloud Storage로 무리 없이 마이그레이션 가능
85+
- **로컬 개발 환경**: 프로덕션 환경과 동일한 API로 개발, 벤더 락인 없이 자유로운 개발
86+
- **셀프 호스팅**: Docker/Podman으로 로컬에서 실행, 외부 의존성이나 서비스 계정 불필요
87+
- **오픈 소스**: 데이터에 대한 완전한 제어권을 가진 엔터프라이즈급 오브젝트 스토리지
88+
8289
## 모바일
8390

8491
### Flutter 3.38

docs/WHY.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,13 @@ This document explains the reasoning behind each technology choice in this fulls
7979
- **Persistence options**: RDB snapshots or AOF for durability
8080
- **Cluster support**: Horizontal scaling when needed
8181

82+
### MinIO
83+
84+
- **S3 Compatible**: Drop-in replacement for AWS S3 API, seamless migration to production Cloud Storage
85+
- **Local development**: Same API as production environment, no vendor lock-in during development
86+
- **Self-hosted**: Runs locally with Docker/Podman, no external dependencies or service accounts required
87+
- **Open source**: Enterprise-grade object storage with full control over data
88+
8289
## Mobile
8390

8491
### Flutter 3.38

mise.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ format = { depends = ["//apps/api:format", "//apps/web:format", "//apps/worker:f
2121
test = { depends = ["//apps/api:test", "//apps/web:test", "//apps/worker:test"], description = "Test all apps" }
2222
typecheck = { depends = ["//apps/api:typecheck", "//apps/web:typecheck"], description = "Type check all apps" }
2323
"i18n:build" = { depends = ["//packages/i18n:build"], description = "Build i18n files" }
24-
"design-token:build" = { depends = ["//packages/design-tokens:build"], description = "Build design tokens" }
24+
"tokens:build" = { depends = ["//packages/design-tokens:build"], description = "Build design tokens" }
2525
"gen:api" = { run = "mise //apps/api:gen:openapi && mise //apps/web:gen:api", description = "Generate OpenAPI schema and API clients" }
2626
"infra:up" = { depends = ["//apps/api:infra:up"], description = "Start local infrastructure" }
2727
"infra:down" = { depends = ["//apps/api:infra:down"], description = "Stop local infrastructure" }

0 commit comments

Comments
 (0)