github-project-manager 0.1.1 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +127 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,127 @@
|
|
|
1
|
+
# GPM - GitHub Project Manager
|
|
2
|
+
|
|
3
|
+
GitHub Project V2를 CLI와 웹 UI로 관리하는 도구. Claude Code에서 bash로 태스크를 관리하고, 브라우저에서 칸반 보드로 시각화합니다.
|
|
4
|
+
|
|
5
|
+
## 설치
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install -g github-project-manager
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## 사전 조건
|
|
12
|
+
|
|
13
|
+
- Node.js 22+
|
|
14
|
+
- [GitHub CLI](https://cli.github.com/) 설치 및 인증 (`gh auth login`)
|
|
15
|
+
- GitHub Project V2
|
|
16
|
+
|
|
17
|
+
## 빠른 시작
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
# 1. GitHub Project 연결 (git repo 안에서 실행)
|
|
21
|
+
npx github-project-manager init
|
|
22
|
+
|
|
23
|
+
# 2. GitHub에서 태스크 가져오기
|
|
24
|
+
npx github-project-manager sync
|
|
25
|
+
|
|
26
|
+
# 3. 태스크 목록 확인
|
|
27
|
+
npx github-project-manager task list
|
|
28
|
+
|
|
29
|
+
# 4. 웹 UI 실행
|
|
30
|
+
npx github-project-manager server
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## CLI 명령어
|
|
34
|
+
|
|
35
|
+
### 초기 설정
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
npx github-project-manager init # GitHub Project URL 입력 → .gpmrc 생성
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
### 태스크 관리
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
npx github-project-manager task list # 태스크 목록
|
|
45
|
+
npx github-project-manager task list --json # JSON 출력 (Claude Code 연동)
|
|
46
|
+
npx github-project-manager task show <id> # 태스크 상세
|
|
47
|
+
npx github-project-manager task create <title> # 태스크 생성 (GitHub에 직접 반영)
|
|
48
|
+
npx github-project-manager task update <id> # 태스크 수정
|
|
49
|
+
npx github-project-manager task status <id> <status> # 상태 변경
|
|
50
|
+
npx github-project-manager task delete <id> # 태스크 삭제
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
### 동기화
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
npx github-project-manager sync # GitHub → 로컬 DB 동기화
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
### 웹 서버
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
npx github-project-manager server # API + 웹 UI 서버 시작 (포트 6170)
|
|
63
|
+
npx github-project-manager server --port 8080 # 포트 변경
|
|
64
|
+
npx github-project-manager server --no-open # 브라우저 자동 열기 비활성화
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
> **Tip**: 글로벌 설치(`npm i -g github-project-manager`) 후에는 `gpm` 명령어로 짧게 사용 가능합니다.
|
|
68
|
+
|
|
69
|
+
## 아키텍처
|
|
70
|
+
|
|
71
|
+
```
|
|
72
|
+
npx github-project-manager init (any git repo)
|
|
73
|
+
→ .gpmrc 생성 + DB에 프로젝트 등록
|
|
74
|
+
|
|
75
|
+
npx github-project-manager task create "제목"
|
|
76
|
+
→ GitHub Project에 Draft Issue 직접 생성
|
|
77
|
+
|
|
78
|
+
npx github-project-manager sync
|
|
79
|
+
→ GitHub → 로컬 SQLite DB (Pull only)
|
|
80
|
+
|
|
81
|
+
npx github-project-manager server (port 6170)
|
|
82
|
+
→ NestJS API + React 웹 UI 단일 포트 서빙
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
- **GitHub = SSOT**: 쓰기는 GitHub에 직접 반영, 로컬 DB는 읽기 캐시
|
|
86
|
+
- **멀티 프로젝트**: 하나의 서버에서 여러 GitHub Project 관리
|
|
87
|
+
- **CLI 독립 실행**: NestJS Standalone Mode로 서버 없이도 CLI 사용 가능
|
|
88
|
+
|
|
89
|
+
## 기술 스택
|
|
90
|
+
|
|
91
|
+
| 영역 | 기술 |
|
|
92
|
+
|------|------|
|
|
93
|
+
| CLI | Commander.js, TypeScript |
|
|
94
|
+
| Backend | NestJS, TypeORM, SQLite |
|
|
95
|
+
| Frontend | React, Vite, TailwindCSS |
|
|
96
|
+
| GitHub API | Octokit GraphQL API v4 |
|
|
97
|
+
|
|
98
|
+
## 개발
|
|
99
|
+
|
|
100
|
+
```bash
|
|
101
|
+
# 의존성 설치
|
|
102
|
+
yarn install
|
|
103
|
+
|
|
104
|
+
# 개발 서버 (터미널 2개)
|
|
105
|
+
yarn dev:backend # NestJS (포트 6170)
|
|
106
|
+
yarn dev:frontend # Vite (포트 6171, proxy → 6170)
|
|
107
|
+
|
|
108
|
+
# 전체 빌드
|
|
109
|
+
yarn build
|
|
110
|
+
|
|
111
|
+
# CLI 실행
|
|
112
|
+
yarn gpm -- task list
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
## 배포
|
|
116
|
+
|
|
117
|
+
```bash
|
|
118
|
+
./deploy.sh patch # 0.1.0 → 0.1.1
|
|
119
|
+
./deploy.sh minor # 0.1.0 → 0.2.0
|
|
120
|
+
./deploy.sh major # 0.1.0 → 1.0.0
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
`v*` 태그 push 시 GitHub Actions가 자동으로 npm에 배포합니다.
|
|
124
|
+
|
|
125
|
+
## 라이선스
|
|
126
|
+
|
|
127
|
+
MIT
|