@daawoonkim/create-arch-app 0.1.0 → 0.2.0

package/CONTRIBUTING.md

@@ -0,0 +1,172 @@
+# Contributing to create-arch-app
+
+Thank you for your interest in contributing to create-arch-app! 🎉
+
+## 🚀 Getting Started
+
+### Prerequisites
+- Node.js 18.0.0 or higher
+- npm or yarn
+- Git
+
+### Setup Development Environment
+
+```bash
+# Clone the repository
+git clone git@github.com:hec8897/create-arch-app.git
+cd create-arch-app
+
+# Install dependencies
+npm install
+
+# Build the project
+npm run build
+
+# Link for local testing
+npm link
+```
+
+## 🔄 Development Workflow
+
+### 1. Create a Feature Branch
+
+```bash
+git checkout main
+git pull origin main
+git checkout -b feature/your-feature-name
+```
+
+### 2. Make Your Changes
+
+- Write clear, concise commit messages
+- Follow existing code style
+- Add tests if applicable
+- Update documentation
+
+### 3. Test Your Changes
+
+```bash
+# Build
+npm run build
+
+# Test locally
+cd ~/test-projects
+create-arch-app test-app
+
+# Verify the generated project
+cd test-app
+npm install
+npm run dev
+```
+
+### 4. Commit Your Changes
+
+```bash
+git add .
+git commit -m "feat: add new feature"
+```
+
+**Commit Message Format:**
+- `feat:` - New feature
+- `fix:` - Bug fix
+- `docs:` - Documentation changes
+- `style:` - Code style changes (formatting, etc.)
+- `refactor:` - Code refactoring
+- `test:` - Adding or updating tests
+- `chore:` - Build process or auxiliary tool changes
+
+### 5. Push and Create PR
+
+```bash
+git push origin feature/your-feature-name
+```
+
+Then create a Pull Request on GitHub.
+
+## 📝 Code Guidelines
+
+### TypeScript
+- Use TypeScript for all new code
+- Maintain type safety
+- Use interfaces for public APIs
+
+### File Structure
+- Keep generators modular
+- Separate concerns (prompts, generators, utils)
+- Use meaningful file and function names
+
+### Testing
+- Test major features manually
+- Verify all architecture patterns work
+- Check both React and Next.js outputs
+
+## 🐛 Bug Reports
+
+When reporting bugs, please include:
+- Steps to reproduce
+- Expected behavior
+- Actual behavior
+- Your environment (OS, Node version)
+- CLI options used
+
+## 💡 Feature Requests
+
+We welcome feature requests! Please:
+- Check if it already exists in issues
+- Describe the use case
+- Explain why it would be useful
+- Consider backward compatibility
+
+## 📦 Adding New Features
+
+### Adding a New Architecture Pattern
+
+1. Update `src/types.ts` with new architecture type
+2. Add prompt option in `src/prompts/projectSetup.ts`
+3. Create generator logic in `src/generators/`
+4. Test with both React and Next.js
+5. Update README.md and documentation
+
+### Adding a New Library Option
+
+1. Update types in `src/types.ts`
+2. Add prompt in `src/prompts/projectSetup.ts`
+3. Update `src/utils/dependencies.ts`
+4. Update generators to include the library
+5. Test integration
+6. Update documentation
+
+## ✅ Pull Request Checklist
+
+Before submitting a PR, ensure:
+
+- [ ] Code builds successfully (`npm run build`)
+- [ ] Tested manually with at least 2 architecture patterns
+- [ ] Updated README.md if needed
+- [ ] Updated CHANGELOG.md
+- [ ] Commit messages follow convention
+- [ ] No console.logs in production code
+- [ ] TypeScript types are correct
+
+## 🎯 Priority Areas
+
+We're especially interested in contributions for:
+- Additional architecture patterns
+- More library integrations
+- Improved error handling
+- Better testing coverage
+- Documentation improvements
+
+## 📞 Questions?
+
+- Open an issue for discussion
+- Check existing issues and PRs
+- Review documentation
+
+## 📄 License
+
+By contributing, you agree that your contributions will be licensed under the MIT License.
+
+---
+
+Thank you for contributing! 🙏

package/PUBLISHING.md

@@ -0,0 +1,304 @@
+# npm 배포 가이드
+
+이 문서는 `@daawoonkim/create-arch-app` 패키지를 npm에 배포하는 방법을 설명합니다.
+
+## 📋 사전 요구사항
+
+- npm 계정 (https://www.npmjs.com/)
+- npm CLI 로그인
+- 프로젝트 빌드 완료
+
+## 🔐 1. npm 인증 설정
+
+### 방법 1: Automation Token 사용 (권장)
+
+**npm 웹사이트에서 토큰 생성:**
+
+1. https://www.npmjs.com/settings/daawoonkim/tokens 접속
+2. "Generate New Token" 클릭
+3. **Token Type: "Automation"** 선택 (중요!)
+4. 설명 입력 (예: "create-arch-app deployment")
+5. "Generate Token" 클릭
+6. 토큰 복사 (한 번만 표시됨!)
+
+**로컬에 토큰 설정:**
+
+```bash
+# .npmrc 파일에 토큰 추가
+echo "//registry.npmjs.org/:_authToken=YOUR_TOKEN_HERE" > ~/.npmrc
+
+# 권한 설정
+chmod 600 ~/.npmrc
+```
+
+`YOUR_TOKEN_HERE`를 생성한 토큰으로 교체하세요.
+
+### 방법 2: 브라우저 로그인
+
+```bash
+npm login
+```
+
+브라우저가 열리면 로그인하고 인증을 완료하세요.
+
+### 방법 3: OTP 사용
+
+```bash
+# 로그인
+npm login
+
+# 배포 시 OTP 코드 포함
+npm publish --access public --otp=123456
+```
+
+인증 앱에서 6자리 코드를 받아 사용하세요.
+
+## 📦 2. 배포 전 체크리스트
+
+### 버전 확인 및 업데이트
+
+```bash
+# 현재 버전 확인
+npm version
+
+# 버전 업데이트 (자동으로 git tag 생성)
+npm version patch   # 0.1.0 -> 0.1.1 (버그 수정)
+npm version minor   # 0.1.0 -> 0.2.0 (새 기능)
+npm version major   # 0.1.0 -> 1.0.0 (큰 변경)
+```
+
+### 빌드 확인
+
+```bash
+# TypeScript 컴파일
+npm run build
+
+# dist 폴더 확인
+ls -la dist/
+```
+
+### 테스트 실행
+
+```bash
+# 로컬에서 CLI 테스트
+npm link
+create-arch-app test-project
+
+# 링크 해제
+npm unlink -g create-arch-app
+```
+
+### package.json 확인
+
+필수 필드 확인:
+- ✅ `name`: `@daawoonkim/create-arch-app`
+- ✅ `version`: 업데이트된 버전
+- ✅ `description`: 패키지 설명
+- ✅ `keywords`: 검색 키워드
+- ✅ `repository`: GitHub 링크
+- ✅ `license`: MIT
+- ✅ `bin`: CLI 진입점
+
+### .npmignore 확인
+
+배포에서 제외할 파일 확인:
+```
+src/
+*.plan.md
+tsconfig.json
+.git/
+.github/
+test-output/
+```
+
+## 🚀 3. 배포 실행
+
+### 배포 명령어
+
+```bash
+npm publish --access public
+```
+
+### 배포 확인
+
+```bash
+# npm에서 패키지 정보 확인
+npm info @daawoonkim/create-arch-app
+
+# 설치 테스트
+npx @daawoonkim/create-arch-app test-app
+```
+
+## 🏷️ 4. Git 태그 및 릴리즈
+
+### Git 태그 생성
+
+```bash
+# 태그 생성 (npm version이 자동 생성하지만, 수동으로도 가능)
+git tag v0.1.1
+
+# 태그 푸시
+git push --tags
+```
+
+### GitHub 릴리즈 생성
+
+1. https://github.com/hec8897/create-arch-app/releases 접속
+2. "Create a new release" 클릭
+3. 태그 선택 (v0.1.1)
+4. 릴리즈 노트 작성:
+
+```markdown
+## v0.1.1
+
+### 🐛 Bug Fixes
+- 버그 수정 내용
+
+### ✨ Features
+- 새로운 기능
+
+### 📝 Documentation
+- 문서 업데이트
+```
+
+5. "Publish release" 클릭
+
+## 🔄 5. 전체 배포 워크플로우
+
+```bash
+# 1. 변경사항 커밋
+git add .
+git commit -m "feat: add new feature"
+
+# 2. 버전 업데이트 (자동으로 tag 생성)
+npm version patch
+
+# 3. 빌드
+npm run build
+
+# 4. 배포
+npm publish --access public
+
+# 5. Git 푸시 (태그 포함)
+git push origin main --tags
+```
+
+## ⚠️ 6. 문제 해결
+
+### 2FA 에러
+
+```
+npm ERR! 403 Two-factor authentication required
+```
+
+**해결책:**
+- OTP 코드 사용: `npm publish --access public --otp=123456`
+- 또는 Automation Token 사용 (위 1단계 참조)
+
+### 인증 에러
+
+```
+npm ERR! 401 Unauthorized
+```
+
+**해결책:**
+```bash
+npm logout
+npm login
+```
+
+### 버전 충돌
+
+```
+npm ERR! 403 cannot publish over existing version
+```
+
+**해결책:**
+```bash
+# 버전 업데이트
+npm version patch
+npm publish --access public
+```
+
+## 📊 7. 배포 후 확인
+
+### npm 패키지 페이지
+https://www.npmjs.com/package/@daawoonkim/create-arch-app
+
+### 다운로드 통계
+```bash
+npm info @daawoonkim/create-arch-app
+```
+
+### 사용자 테스트
+```bash
+# 다른 디렉토리에서
+cd ~/test-npm-package
+npx @daawoonkim/create-arch-app my-test-app
+```
+
+## 🔒 8. 보안
+
+### .npmrc 파일 보호
+
+```bash
+# 절대로 Git에 커밋하지 마세요!
+echo ".npmrc" >> .gitignore
+
+# 파일 권한 설정
+chmod 600 ~/.npmrc
+```
+
+### 토큰 갱신
+
+Automation Token은 만료되지 않지만, 정기적으로 갱신하는 것이 좋습니다:
+1. npm 웹사이트에서 기존 토큰 삭제
+2. 새 토큰 생성
+3. ~/.npmrc 파일 업데이트
+
+## 📝 9. 버전 관리 전략
+
+### Semantic Versioning
+
+- **MAJOR** (1.0.0): 호환되지 않는 API 변경
+- **MINOR** (0.1.0): 하위 호환되는 새 기능
+- **PATCH** (0.0.1): 하위 호환되는 버그 수정
+
+### 버전 업데이트 가이드
+
+```bash
+# 버그 수정
+npm version patch
+
+# 새 기능 추가 (하위 호환)
+npm version minor
+
+# 큰 변경 (Breaking Changes)
+npm version major
+
+# 베타 버전
+npm version prerelease --preid=beta
+```
+
+## 🎯 10. 체크리스트
+
+배포 전 확인사항:
+
+- [ ] 코드 변경사항 커밋 완료
+- [ ] 테스트 통과
+- [ ] 버전 업데이트 (`npm version`)
+- [ ] CHANGELOG 업데이트
+- [ ] README 업데이트
+- [ ] 빌드 성공 (`npm run build`)
+- [ ] npm 로그인 확인
+- [ ] 배포 실행 (`npm publish --access public`)
+- [ ] Git 태그 푸시 (`git push --tags`)
+- [ ] GitHub 릴리즈 생성
+- [ ] npm 패키지 페이지 확인
+- [ ] 실제 설치 테스트
+
+## 📚 참고 자료
+
+- npm 문서: https://docs.npmjs.com/
+- Semantic Versioning: https://semver.org/
+- npm 토큰: https://docs.npmjs.com/about-access-tokens

package/README.md

@@ -1,7 +1,18 @@
 # 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)
+
 DDD, Clean Architecture, Atomic Design을 지원하는 대화형 React/Next.js 프로젝트 생성 CLI 도구
 
+**📦 npm**: https://www.npmjs.com/package/@daawoonkim/create-arch-app
+
+> ⚠️ **현재 MVP(Minimum Viable Product) 버전입니다.** 핵심 기능은 모두 작동하지만, 활발히 개발 중이며 피드백을 받고 있습니다. 이슈나 제안 사항이 있으시면 [GitHub Issues](https://github.com/hec8897/create-arch-app/issues)에 남겨주세요!
+
 ## 특징
 
 ✨ **4가지 아키텍처 패턴 지원**
@@ -238,14 +249,54 @@ cd ~/test-project
 create-arch-app my-test-app
 ```
 
+### npm 배포
+
+npm 배포 방법은 [PUBLISHING.md](./PUBLISHING.md)를 참조하세요.
+
+**자동 배포:** main 브랜치에 merge되면 자동으로 npm 배포가 실행됩니다!
+
+```bash
+# 1. 버전 업데이트
+npm version patch  # 0.1.0 → 0.1.1
+
+# 2. PR 생성 및 merge
+# main에 merge → 자동 배포!
+
+# 자세한 내용: .github/WORKFLOWS.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
+- ✅ 현재 디렉토리 생성 지원 (`.` 옵션)
+
+**알려진 제한사항:**
+- 일부 조합에서 테스트가 완료되지 않았을 수 있습니다
+- 에러 처리 개선 필요
+- 더 많은 커스터마이징 옵션 추가 예정
+
 ## 로드맵
 
+### v0.2.0 (계획 중)
+- [ ] 추가 UI 라이브러리 통합 (shadcn/ui, MUI)
+- [ ] 더 많은 테스트 및 안정성 개선
+- [ ] 컴포넌트 생성기 추가
+
+### v0.3.0 이후
 - [ ] 추가 아키텍처 패턴 (Feature-Sliced Design, Hexagonal Architecture)
-- [ ] UI 라이브러리 통합 (shadcn/ui, MUI, Ant Design)
 - [ ] 추가 상태관리 옵션 (Redux Toolkit, Jotai, Recoil)
 - [ ] 인증 통합 (NextAuth, Supabase)
 - [ ] ORM 통합 (Prisma, Drizzle)
-- [ ] 컴포넌트 생성기
 - [ ] CI/CD 설정 자동화
 - [ ] Docker 설정 포함
 - [ ] Monorepo 지원 (Turborepo)
@@ -254,6 +305,29 @@ create-arch-app my-test-app
 
 버그 리포트, 기능 제안, PR 모두 환영합니다!
 
+자세한 내용은 [CONTRIBUTING.md](./CONTRIBUTING.md)를 참조하세요.
+
+### 개발 환경 설정
+
+```bash
+# 저장소 클론
+git clone git@github.com:hec8897/create-arch-app.git
+cd create-arch-app
+
+# 의존성 설치
+npm install
+
+# TypeScript 컴파일
+npm run build
+
+# 로컬 링크 생성
+npm link
+
+# 테스트
+cd ~/test-project
+create-arch-app my-test-app
+```
+
 ## 라이선스
 
 MIT

package/dist/generators/index.js

@@ -93,10 +93,11 @@ async function generateTsConfig(config, projectPath) {
                     },
                 ],
                 paths: {
-                    '@/*': ['./*'],
+                    '@/*': ['./src/*'],
                 },
+                baseUrl: '.',
             },
-            include: ['next-env.d.ts', '**/*.ts', '**/*.tsx', '.next/types/**/*.ts'],
+            include: ['next-env.d.ts', '**/*.ts', '**/*.tsx', '.next/types/**/*.ts', 'src/**/*.ts', 'src/**/*.tsx'],
             exclude: ['node_modules'],
         };
         await writeJson(path.join(projectPath, 'tsconfig.json'), tsConfig);
@@ -135,6 +136,67 @@ next-env.d.ts
     await createFile(path.join(projectPath, '.gitignore'), content);
 }
 async function generateReadme(config, projectPath) {
+    const apiSection = (config.apiClient !== 'none' || config.dataFetching !== 'none') ? `
+## API 통합
+
+이 프로젝트는 다음 API 라이브러리를 사용합니다:
+${config.apiClient !== 'none' ? `- **HTTP 클라이언트**: ${config.apiClient === 'axios' ? 'Axios' : 'Fetch API'}` : ''}
+${config.dataFetching !== 'none' ? `- **데이터 페칭**: ${config.dataFetching === 'react-query' ? 'TanStack Query (React Query)' : 'SWR'}` : ''}
+
+### API 클라이언트 사용법
+
+${config.apiClient === 'axios' ? `\`\`\`typescript
+import { apiClient } from './lib/api';
+
+const fetchData = async () => {
+  const response = await apiClient.get('/endpoint');
+  return response.data;
+};
+\`\`\`` : config.apiClient === 'fetch' ? `\`\`\`typescript
+import { apiClient } from './lib/api';
+
+const fetchData = async () => {
+  const data = await apiClient.get('/endpoint');
+  return data;
+};
+\`\`\`` : ''}
+
+${config.dataFetching === 'react-query' ? `### React Query 사용법
+
+\`\`\`typescript
+import { useExamples } from './hooks/queries/useExample';
+
+const Component = () => {
+  const { data, isLoading, error } = useExamples();
+  
+  if (isLoading) return <div>Loading...</div>;
+  if (error) return <div>Error occurred</div>;
+  
+  return <div>{/* Use data */}</div>;
+};
+\`\`\`` : config.dataFetching === 'swr' ? `### SWR 사용법
+
+\`\`\`typescript
+import { useExamples } from './hooks/queries/useExample';
+
+const Component = () => {
+  const { data, isLoading, isError } = useExamples();
+  
+  if (isLoading) return <div>Loading...</div>;
+  if (isError) return <div>Error occurred</div>;
+  
+  return <div>{/* Use data */}</div>;
+};
+\`\`\`` : ''}
+
+### 환경변수 설정
+
+\`.env.local\` 파일을 생성하고 API URL을 설정하세요:
+
+\`\`\`bash
+${config.framework === 'nextjs' ? 'NEXT_PUBLIC_API_URL' : 'VITE_API_URL'}=http://localhost:3000/api
+\`\`\`
+` : '';
     const content = `# ${config.projectName}
 
 이 프로젝트는 **create-arch-app**으로 생성되었습니다.
@@ -148,6 +210,8 @@ ${config.framework === 'nextjs' ? `- **라우터**: ${config.router === 'app' ?
 - **스타일링**: ${config.styling === 'tailwind' ? 'Tailwind CSS' : 'CSS Modules'}
 - **상태관리**: ${config.stateManagement}
 ${config.formLibrary !== 'none' ? `- **폼**: ${config.formLibrary}\n` : ''}
+${config.apiClient !== 'none' ? `- **HTTP 클라이언트**: ${config.apiClient === 'axios' ? 'Axios' : 'Fetch'}\n` : ''}
+${config.dataFetching !== 'none' ? `- **데이터 페칭**: ${config.dataFetching === 'react-query' ? 'TanStack Query' : 'SWR'}\n` : ''}
 ${config.testing ? '- **테스팅**: Vitest + Testing Library\n' : ''}
 
 ## 시작하기
@@ -163,7 +227,7 @@ npm run dev
 npm run build
 ${config.testing ? '\n# 테스트 실행\nnpm test' : ''}
 \`\`\`
-
+${apiSection}
 ## 아키텍처 구조
 
 ### ${config.architecture.toUpperCase()}
@@ -192,12 +256,8 @@ async function generateTailwindConfig(config, projectPath) {
         contentPaths = ['./index.html', './src/**/*.{js,ts,jsx,tsx}'];
     }
     else {
-        if (config.router === 'app') {
-            contentPaths = ['./app/**/*.{js,ts,jsx,tsx}', './components/**/*.{js,ts,jsx,tsx}'];
-        }
-        else {
-            contentPaths = ['./pages/**/*.{js,ts,jsx,tsx}', './components/**/*.{js,ts,jsx,tsx}'];
-        }
+        // Next.js - src 폴더 사용
+        contentPaths = ['./src/**/*.{js,ts,jsx,tsx}'];
     }
     const tailwindConfig = `/** @type {import('tailwindcss').Config} */
 module.exports = {