docs: 초기 파일 추가 및 기본 설정 구성
- .git-commit-template.txt: 커밋 메시지 템플릿 추가 - .gitignore: OS 및 데이터베이스 관련 파일 무시 설정 추가 - .mcp.json: MCP 서버 설정 추가 - CLAUDE.md: SuperClaude 엔트리 포인트 문서 추가 - README.md: 프로젝트 템플릿 설명 추가 - .claude/COMMANDS.md: 명령어 실행 프레임워크 문서 추가 - .claude/FLAGS.md: 플래그 시스템 문서 추가 - .claude/MCP.md: MCP 서버 통합 문서 추가 - .claude/MODES.md: 운영 모드 문서 추가 - .claude/ORCHESTRATOR.md: 지능형 라우팅 시스템 문서 추가 - .claude/PERSONAS.md: 페르소나 시스템 문서 추가 - .claude/PRINCIPLES.md: 핵심 원칙 문서 추가 - .claude/RULES.md: 실행 가능한 규칙 문서 추가 - .claude/settings.json: 권한 설정 추가 - .claude/commands 디렉토리: 다양한 명령어 문서 추가 - .taskmaster/config.json: 기본 설정 파일 추가 - .taskmaster/docs 디렉토리: 문서 파일 추가 - .taskmaster/tasks/tasks.json: 기본 작업 파일 추가
This commit is contained in:
176
README.md
176
README.md
@ -0,0 +1,176 @@
|
||||
# SuperClaude 기반 프로젝트 템플릿 🚀
|
||||
|
||||
[](https://opensource.org/licenses/MIT)
|
||||
|
||||
[](https://github.com/your-repo/tpl-superclaude)
|
||||
|
||||
[](https://github.com/your-repo/tpl-superclaude/issues)
|
||||
|
||||
[](https://github.com/your-repo/tpl-superclaude/blob/main/CONTRIBUTING.md)
|
||||
|
||||
이 템플릿은 SuperClaude v3 프레임워크를 기반으로 한 기본 프로젝트 구조를 제공합니다. Claude Code를 확장하여 개발 작업을 더 효율적으로 수행할 수 있도록 설계되었습니다. 이 템플릿을 사용하면 데이터 분석, 앱 개발, 웹 서비스 구축 등 다양한 프로젝트를 쉽게 시작할 수 있습니다.
|
||||
|
||||
**📢 상태**: 기본 템플릿으로, SuperClaude v3의 초기 릴리스에 기반합니다. 추가 커스터마이징을 권장합니다.
|
||||
|
||||
## 이 템플릿은 무엇인가요? 🤔
|
||||
|
||||
이 템플릿은 SuperClaude 프레임워크를 활용한 프로젝트의 시작점입니다. 주요 특징:
|
||||
|
||||
- 🛠️ **SuperClaude 명령어 지원**: 16개의 전문 명령어(예: `/sc:implement`, `/sc:analyze`)를 통해 개발 태스크를 처리.
|
||||
- 🎭 **스마트 페르소나**: 도메인 전문가(architect, frontend 등)가 자동으로 참여.
|
||||
- 🔧 **MCP 서버 통합**: 문서 검색, UI 생성, 브라우저 자동화 등 외부 도구 연동.
|
||||
- 📋 **다양한 프로젝트 적용**: 데이터 분석(예: Pandas, Matplotlib), 앱 개발(예: React, Flask) 등에 활용 가능.
|
||||
- ⚡ **토큰 최적화**: 긴 대화에서도 효율적으로 작동.
|
||||
|
||||
이 템플릿을 클론하거나 포크하여, 자신의 프로젝트에 맞게 확장하세요!
|
||||
|
||||
## 현재 상태 📊
|
||||
|
||||
✅ **잘 작동하는 부분**:
|
||||
|
||||
- SuperClaude 설치 및 기본 설정.
|
||||
- 핵심 명령어와 페르소나 시스템.
|
||||
- MCP 서버 기본 통합.
|
||||
|
||||
⚠️ **알려진 이슈**:
|
||||
|
||||
- SuperClaude v3 초기 버전이므로 버그 발생 가능.
|
||||
- 프로젝트별 커스터마이징 필요 (문서 개선 중).
|
||||
|
||||
## 주요 기능 ✨
|
||||
|
||||
### 명령어 🛠️
|
||||
|
||||
SuperClaude의 16개 명령어를 활용하세요:
|
||||
|
||||
- **개발**: `/sc:implement`, `/sc:build`, `/sc:design`
|
||||
- **분석**: `/sc:analyze`, `/sc:troubleshoot`, `/sc:explain`
|
||||
- **품질**: `/sc:improve`, `/sc:test`, `/sc:cleanup`
|
||||
- **기타**: `/sc:document`, `/sc:git`, `/sc:estimate`, `/sc:task`, `/sc:index`, `/sc:load`, `/sc:spawn`
|
||||
|
||||
### 스마트 페르소나 🎭
|
||||
|
||||
자동으로 적합한 전문가를 선택:
|
||||
|
||||
- 🏗️ **architect** - 시스템 설계.
|
||||
- 🎨 **frontend** - UI/UX (React 등).
|
||||
- ⚙️ **backend** - API (Flask, Django 등).
|
||||
- *기타 8개 페르소나*.
|
||||
|
||||
### MCP 통합 🔧
|
||||
|
||||
- **Context7**: 라이브러리 문서 검색 (예: Pandas API).
|
||||
- **Sequential**: 다단계 태스크 처리.
|
||||
- **Magic**: UI 컴포넌트 생성 (React 컴포넌트).
|
||||
- **Playwright**: 브라우저 테스트.
|
||||
|
||||
## v2에서 업그레이드 시 주의사항 ⚠️
|
||||
|
||||
v2 사용자는 먼저 기존 파일을 정리하세요:
|
||||
|
||||
1. v2 제거.
|
||||
2. 디렉토리 삭제: `SuperClaude/`, `~/.claude/shared/` 등.
|
||||
3. v3 설치 진행.
|
||||
|
||||
- 명령어 변경: v2 `/build` → v3 `/sc:implement`.
|
||||
|
||||
## 설치 📦
|
||||
|
||||
SuperClaude를 설치하고 이 템플릿을 설정하는 2단계 과정입니다.
|
||||
|
||||
### 단계 1: 패키지 설치
|
||||
|
||||
**PyPI에서 (권장)**:
|
||||
|
||||
```bash
|
||||
uv add SuperClaude
|
||||
```
|
||||
|
||||
**소스에서**:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/NomenAK/SuperClaude.git
|
||||
cd SuperClaude
|
||||
uv sync
|
||||
```
|
||||
|
||||
**UV 설치 (필요 시)**:
|
||||
|
||||
```bash
|
||||
curl -Ls https://astral.sh/uv/install.sh | sh
|
||||
uv venv
|
||||
source .venv/bin/activate
|
||||
uv pip install SuperClaude
|
||||
```
|
||||
|
||||
### 단계 2: 설치자 실행
|
||||
|
||||
```bash
|
||||
SuperClaude install # 빠른 설치
|
||||
# 또는
|
||||
SuperClaude install --interactive # 컴포넌트 선택
|
||||
SuperClaude install --minimal # 최소 설치
|
||||
SuperClaude install --profile developer # 개발자 모드
|
||||
```
|
||||
|
||||
**Python 3.7+가 필요합니다.** (Linux: `sudo apt install python3 python3-pip`)
|
||||
|
||||
템플릿 클론 후, 프로젝트 디렉토리에서 SuperClaude를 실행하세요.
|
||||
|
||||
## 템플릿 활용 예시 🔄
|
||||
|
||||
이 템플릿을 사용해 다양한 프로젝트를 시작하세요:
|
||||
|
||||
1. **데이터 분석 프로젝트**:
|
||||
|
||||
- 라이브러리: Pandas, NumPy, Matplotlib.
|
||||
- 명령어 예: `/sc:analyze 데이터셋 분석` – 데이터 탐색 및 시각화.
|
||||
- MCP: Context7로 Pandas 문서 검색.
|
||||
1. **앱 개발 프로젝트**:
|
||||
|
||||
- 프론트엔드: React 앱 생성 (`/sc:implement React 컴포넌트`).
|
||||
- 백엔드: Flask API 구축 (`/sc:design API 엔드포인트`).
|
||||
- 테스트: `/sc:test unit 테스트 작성`, Playwright로 E2E 테스트.
|
||||
1. **기타 프로젝트**:
|
||||
|
||||
- 웹 서비스: `/sc:build Docker 컨테이너`.
|
||||
- 문서화: `/sc:document README 업데이트`.
|
||||
|
||||
프로젝트 구조를 `src/`, `data/`, `tests/` 등으로 확장하세요.
|
||||
|
||||
## 향후 계획 🔮
|
||||
|
||||
- v4: 훅 시스템 재도입, 추가 MCP 통합.
|
||||
- 더 많은 페르소나와 크로스-CLI 지원.
|
||||
|
||||
## 설정 ⚙️
|
||||
|
||||
`~/.claude/settings.json` 편집으로 커스터마이징. 대부분 기본 설정으로 충분합니다.
|
||||
|
||||
## 문서 📖
|
||||
|
||||
- [User Guide](https://github.com/NomenAK/SuperClaude/blob/master/Docs/superclaude-user-guide.md)
|
||||
- [Commands Guide](https://github.com/NomenAK/SuperClaude/blob/master/Docs/commands-guide.md)
|
||||
|
||||
## 프로젝트 구조 📁
|
||||
|
||||
```
|
||||
tpl-superclaude/
|
||||
├── README.md # 프로젝트
|
||||
├── src/ # 소스 코드
|
||||
├── data/ # 데이터 파일
|
||||
├── tests/ # 테스트
|
||||
└── setup.py # 설치 스크립트
|
||||
```
|
||||
|
||||
## FAQ 🙋
|
||||
|
||||
**Q: 이 템플릿으로 어떤 프로젝트를 할 수 있나요?**
|
||||
|
||||
A: 데이터 분석, 앱 개발 등 다양하게. SuperClaude 명령어로 자동화하세요.
|
||||
|
||||
## 라이선스
|
||||
|
||||
MIT - [LICENSE 파일 참조](https://opensource.org/licenses/MIT)
|
||||
|
||||
*SuperClaude를 활용한 효율적인 개발을 시작하세요! 🙂*
|
||||
Reference in New Issue
Block a user