@daawoonkim/create-arch-app 0.1.0 → 0.2.1

package/README.ko.md

@@ -0,0 +1,302 @@
+# create-arch-app
+
+[![npm version](https://img.shields.io/npm/v/@daawoonkim/create-arch-app.svg)](https://www.npmjs.com/package/@daawoonkim/create-arch-app)
+[![npm downloads](https://img.shields.io/npm/dm/@daawoonkim/create-arch-app.svg)](https://www.npmjs.com/package/@daawoonkim/create-arch-app)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+![Status](https://img.shields.io/badge/status-MVP-orange.svg)
+[![CI Tests](https://github.com/hec8897/create-arch-app/actions/workflows/test.yml/badge.svg)](https://github.com/hec8897/create-arch-app/actions/workflows/test.yml)
+[![Lint](https://github.com/hec8897/create-arch-app/actions/workflows/lint.yml/badge.svg)](https://github.com/hec8897/create-arch-app/actions/workflows/lint.yml)
+
+**🌐 언어**: [English](./README.md) | **한국어**
+
+DDD, Clean Architecture, Atomic Design을 지원하는 대화형 React/Next.js 프로젝트 생성 CLI 도구
+
+**📦 npm**: https://www.npmjs.com/package/@daawoonkim/create-arch-app
+
+**📝 CHANGELOG**: [English](./CHANGELOG.md) | [한국어](./CHANGELOG.ko.md)
+
+> ⚠️ **현재 MVP(Minimum Viable Product) 버전입니다.** 핵심 기능은 모두 작동하지만, 활발히 개발 중이며 피드백을 받고 있습니다. 이슈나 제안 사항이 있으시면 [GitHub Issues](https://github.com/hec8897/create-arch-app/issues)에 남겨주세요!
+
+## 특징
+
+✨ **4가지 아키텍처 패턴 지원**
+- DDD (Domain-Driven Design)
+- Clean Architecture  
+- Atomic Design
+- Default (기본 구조)
+
+🚀 **프레임워크 선택**
+- React (with Vite)
+- Next.js (App Router / Pages Router)
+
+💎 **TypeScript 기본 포함**
+
+🎨 **스타일링 옵션**
+- Tailwind CSS
+- CSS Modules
+
+🌐 **API 통합**
+- HTTP 클라이언트: Axios, Fetch API
+- 데이터 페칭: TanStack Query (React Query), SWR
+
+📦 **선택 가능한 라이브러리**
+- 상태관리: Zustand, Context API
+- 폼: React Hook Form
+- 테스팅: Vitest + Testing Library
+
+## 설치 및 사용법
+
+### npx로 즉시 사용 (권장)
+
+```bash
+# 새 디렉토리에 프로젝트 생성
+npx @daawoonkim/create-arch-app my-app
+
+# 또는 현재 디렉토리에 직접 생성
+npx @daawoonkim/create-arch-app .
+```
+
+### 전역 설치
+
+```bash
+npm install -g @daawoonkim/create-arch-app
+
+# 새 디렉토리에 프로젝트 생성
+create-arch-app my-app
+
+# 현재 디렉토리에 직접 생성
+create-arch-app .
+```
+
+> **참고**: 현재 디렉토리(`.`)를 사용하려면 디렉토리가 비어있어야 합니다.
+
+### 대화형 프롬프트
+
+CLI를 실행하면 다음 질문들에 답하게 됩니다:
+
+1. **프레임워크 선택**: React 또는 Next.js
+2. **Next.js 버전 선택** (Next.js만 해당): Latest (권장), 15.x, 14.x, 13.x
+3. **라우터 선택** (Next.js만 해당): App Router (권장) 또는 Pages Router
+4. **아키텍처 패턴**: DDD, Clean, Atomic, Default
+5. **스타일링 도구**: Tailwind CSS 또는 CSS Modules
+6. **상태관리**: Zustand, Context API, None
+7. **폼 라이브러리**: React Hook Form 또는 None
+8. **HTTP 클라이언트**: Axios, Fetch API, None
+9. **데이터 페칭**: TanStack Query (React Query), SWR, None
+10. **테스팅 도구**: Vitest + Testing Library 포함 여부
+
+## 사용 예시
+
+```bash
+npx @daawoonkim/create-arch-app my-enterprise-app
+
+# 대화형 프롬프트
+? 프레임워크를 선택하세요: Next.js
+? Next.js 버전을 선택하세요: Latest (최신 버전, 권장)
+? Next.js 라우터를 선택하세요: App Router (권장)
+? 아키텍처 패턴을 선택하세요: DDD (Domain-Driven Design)
+? 스타일링 도구를 선택하세요: Tailwind CSS
+? 상태관리 라이브러리를 선택하세요: Zustand
+? 폼 라이브러리를 선택하세요: React Hook Form
+? HTTP 클라이언트를 선택하세요: Axios (권장)
+? 데이터 페칭 라이브러리를 선택하세요: TanStack Query (React Query) - 권장
+? 테스팅 도구를 포함하시겠습니까? Yes
+
+✨ 프로젝트 생성 중...
+📦 TypeScript 프로젝트로 설정됩니다 (기본값)
+🚀 Next.js App Router 사용
+✅ 프로젝트 생성 완료!
+
+🎉 프로젝트가 성공적으로 생성되었습니다!
+
+다음 명령어로 시작하세요:
+  cd my-enterprise-app
+  npm install
+  npm run dev
+```
+
+## 아키텍처 패턴 설명
+
+### DDD (Domain-Driven Design)
+
+엔터프라이즈급 애플리케이션에 적합한 패턴입니다.
+
+```
+domain/          # 비즈니스 엔티티와 로직
+  ├── entities/
+  ├── repositories/
+  └── services/
+application/     # 유스케이스
+  ├── usecases/
+  └── ports/
+infrastructure/  # 외부 서비스 통합
+  ├── api/
+  └── persistence/
+presentation/    # UI 컴포넌트
+  ├── components/
+  └── pages/
+```
+
+### Clean Architecture
+
+의존성 규칙과 레이어 분리에 중점을 둔 패턴입니다.
+
+```
+core/           # 비즈니스 로직
+  ├── entities/
+  ├── usecases/
+  └── interfaces/
+features/       # 기능별 모듈
+  └── [feature]/
+      ├── domain/
+      ├── data/
+      └── presentation/
+shared/         # 공통 컴포넌트
+  ├── components/
+  └── utils/
+```
+
+### Atomic Design
+
+UI 컴포넌트 중심 개발에 최적화된 패턴입니다.
+
+```
+components/
+  ├── atoms/      # 가장 작은 UI 단위
+  ├── molecules/  # atoms 조합
+  ├── organisms/  # molecules 조합
+  ├── templates/  # 페이지 레이아웃
+  └── pages/      # 실제 페이지
+hooks/
+utils/
+```
+
+### Default
+
+빠른 시작을 원하는 개발자를 위한 기본 구조입니다.
+
+```
+components/
+hooks/
+pages/ (또는 app/)
+utils/
+styles/
+types/
+```
+
+## 생성되는 파일 구조
+
+### React 프로젝트
+
+```
+my-app/
+├── src/
+│   ├── [architecture folders]
+│   ├── App.tsx
+│   ├── main.tsx
+│   └── index.css
+├── index.html
+├── vite.config.ts
+├── tsconfig.json
+├── package.json
+└── README.md
+```
+
+### Next.js 프로젝트 (App Router)
+
+```
+my-app/
+├── src/
+│   ├── app/
+│   │   ├── layout.tsx
+│   │   ├── page.tsx
+│   │   └── globals.css
+│   └── [architecture folders]
+├── next.config.js
+├── tsconfig.json
+├── package.json
+└── README.md
+```
+
+### Next.js 프로젝트 (Pages Router)
+
+```
+my-app/
+├── src/
+│   ├── pages/
+│   │   ├── _app.tsx
+│   │   ├── _document.tsx
+│   │   └── index.tsx
+│   ├── styles/
+│   │   └── globals.css
+│   └── [architecture folders]
+├── next.config.js
+├── tsconfig.json
+├── package.json
+└── README.md
+```
+
+## 요구 사항
+
+- Node.js 18.0.0 이상
+
+## 버전 정보
+
+### v0.2.0 - 최신 (2025-01-26)
+
+**주요 업데이트:**
+- ✅ API 라이브러리 통합 (Axios, Fetch API, TanStack Query, SWR)
+- ✅ 아키텍처별 API 파일 자동 생성
+- ✅ Next.js 프로젝트 구조 개선 (`src/` 디렉토리 + 절대 경로)
+- ✅ CI/CD 자동화 (GitHub Actions)
+- ✅ 자동 npm 배포 (main 브랜치 merge 시)
+- ✅ 문서 개선 (CHANGELOG, CONTRIBUTING, WORKFLOWS)
+
+자세한 내용은 [CHANGELOG.ko.md](./CHANGELOG.ko.md)를 참조하세요.
+
+### v0.1.0 - MVP 릴리즈
+
+**포함된 기능:**
+- ✅ 4가지 아키텍처 패턴 (DDD, Clean Architecture, Atomic Design, Default)
+- ✅ React (Vite) & Next.js (App Router / Pages Router) 지원
+- ✅ Next.js 버전 선택 (Latest, 15.x, 14.x, 13.x)
+- ✅ TypeScript 기본 포함
+- ✅ 스타일링: Tailwind CSS, CSS Modules
+- ✅ 상태관리: Zustand, Context API
+- ✅ 폼: React Hook Form
+- ✅ 테스팅: Vitest + Testing Library
+- ✅ 현재 디렉토리 생성 지원 (`.` 옵션)
+- ✅ 기본 폴더 구조와 README 자동 생성
+
+## 로드맵
+
+### v0.3.0 (계획 중)
+- [ ] 추가 UI 라이브러리 통합 (shadcn/ui, MUI)
+- [ ] 더 많은 테스트 및 안정성 개선
+- [ ] 컴포넌트 생성기 추가
+
+### 향후 계획
+- [ ] 추가 아키텍처 패턴 (Feature-Sliced Design, Hexagonal Architecture)
+- [ ] 추가 상태관리 옵션 (Redux Toolkit, Jotai, Recoil)
+- [ ] 인증 통합 (NextAuth, Supabase)
+- [ ] ORM 통합 (Prisma, Drizzle)
+- [ ] Docker 설정 포함
+- [ ] Monorepo 지원 (Turborepo)
+
+## 기여하기
+
+버그 리포트, 기능 제안, PR 모두 환영합니다!
+
+자세한 내용은 [CONTRIBUTING.md](./CONTRIBUTING.md)를 참조하세요.
+
+## 라이선스
+
+MIT
+
+## 작성자
+
+daawoonkim
+
+## 참고
+
+이 프로젝트는 현대적인 프론트엔드 개발 모범 사례와 다양한 아키텍처 패턴을 기반으로 합니다.