@daawoonkim/create-arch-app 0.1.0 → 0.2.1

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