Skip to content

Commit dc88940

Browse files
committed
docs: add CLI creation instructions and design-token:build task
1 parent c2cee5b commit dc88940

3 files changed

Lines changed: 47 additions & 8 deletions

File tree

README.ko.md

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -75,14 +75,28 @@ graph TB
7575
7676
![Fullstack](./docs/fullstack.jpg)
7777

78-
## 사전 요구사항
78+
## 빠른 시작
79+
80+
이 템플릿으로 시작하는 방법 중 하나를 선택하세요:
81+
82+
```bash
83+
# CLI로 생성하기
84+
pnpm create fullstack-starter my-app
85+
# 또는
86+
npm create fullstack-starter my-app
87+
```
88+
89+
또는 GitHub에서:
90+
91+
1. **[Use this template](https://github.com/first-fluke/fullstack-starter/generate)**을 클릭하여 새 레포지토리 생성
92+
2. 또는 이 레포지토리를 **[Fork](https://github.com/first-fluke/fullstack-starter/fork)**
93+
94+
### 사전 요구사항
7995

8096
- [mise](https://mise.jdx.dev/) - 런타임 버전 관리자
8197
- [Docker](https://www.docker.com/) - 로컬 인프라 구동
8298
- [Terraform](https://www.terraform.io/) - 클라우드 인프라 (선택 사항)
8399

84-
## 빠른 시작
85-
86100
### 1. 런타임 설치
87101

88102
```bash
@@ -96,6 +110,10 @@ mise install
96110
### 2. 의존성 설치
97111

98112
```bash
113+
# 모든 의존성 일괄 설치 (권장)
114+
mise run install
115+
116+
# 또는 개별 설치
99117
# 웹 의존성 (JS/TS)
100118
cd apps/web && pnpm install
101119

@@ -177,6 +195,7 @@ mise tasks --all
177195
| `mise test` | 전체 앱 테스트 실행 |
178196
| `mise typecheck` | 타입 체크 |
179197
| `mise i18n:build` | 다국어 파일 빌드 |
198+
| `mise design-token:build` | 디자인 토큰 빌드 |
180199
| `mise gen:api` | OpenAPI 스키마 및 클라이언트 생성 |
181200
| `mise infra:up` | 로컬 인프라 시작 |
182201
| `mise infra:down` | 로컬 인프라 중지 |
@@ -310,7 +329,7 @@ mise i18n:build
310329
packages/design-tokens/src/tokens.ts
311330

312331
# 빌드 및 배포
313-
mise //packages/design-tokens:build
332+
mise design-token:build
314333
# 생성 파일:
315334
# - apps/web/src/app/[locale]/tokens.css (CSS 변수)
316335
# - apps/mobile/lib/core/theme/generated_theme.dart (Flutter 테마)

README.md

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -75,14 +75,28 @@ graph TB
7575
7676
![Fullstack](./docs/fullstack.jpg)
7777

78-
## Prerequisites
78+
## Quick Start
79+
80+
Choose one of the following methods to start with this template:
81+
82+
```bash
83+
# Create from CLI
84+
pnpm create fullstack-starter my-app
85+
# or
86+
npm create fullstack-starter my-app
87+
```
88+
89+
Or use GitHub:
90+
91+
1. Click **[Use this template](https://github.com/first-fluke/fullstack-starter/generate)** to create a new repository
92+
2. Or **[Fork](https://github.com/first-fluke/fullstack-starter/fork)** this repository
93+
94+
### Prerequisites
7995

8096
- [mise](https://mise.jdx.dev/) - Runtime version manager
8197
- [Docker](https://www.docker.com/) - Local infrastructure
8298
- [Terraform](https://www.terraform.io/) - Cloud infrastructure (optional)
8399

84-
## Quick Start
85-
86100
### 1. Install Runtimes
87101

88102
```bash
@@ -96,6 +110,10 @@ mise install
96110
### 2. Install Dependencies
97111

98112
```bash
113+
# Install all dependencies at once (recommended)
114+
mise run install
115+
116+
# Or install individually
99117
# Web dependencies (JS/TS)
100118
cd apps/web && pnpm install
101119

@@ -177,6 +195,7 @@ mise tasks --all
177195
| `mise test` | Test all apps |
178196
| `mise typecheck` | Type check |
179197
| `mise i18n:build` | Build i18n files |
198+
| `mise design-token:build` | Build design tokens |
180199
| `mise gen:api` | Generate OpenAPI schema and API clients |
181200
| `mise infra:up` | Start local infrastructure |
182201
| `mise infra:down` | Stop local infrastructure |
@@ -310,7 +329,7 @@ mise i18n:build
310329
packages/design-tokens/src/tokens.ts
311330

312331
# Build and distribute
313-
mise //packages/design-tokens:build
332+
mise design-token:build
314333
# Generated files:
315334
# - apps/web/src/app/[locale]/tokens.css (CSS variables)
316335
# - apps/mobile/lib/core/theme/generated_theme.dart (Flutter Theme)

mise.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +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" }
2425
"gen:api" = { run = "mise //apps/api:gen:openapi && mise //apps/web:gen:api", description = "Generate OpenAPI schema and API clients" }
2526
"infra:up" = { depends = ["//apps/api:infra:up"], description = "Start local infrastructure" }
2627
"infra:down" = { depends = ["//apps/api:infra:down"], description = "Stop local infrastructure" }

0 commit comments

Comments
 (0)