-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathREADME.md.template
More file actions
84 lines (61 loc) · 2.18 KB
/
README.md.template
File metadata and controls
84 lines (61 loc) · 2.18 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
# {{PROJECT_NAME}}
{{PROJECT_DESCRIPTION}}
## Setup
```bash
./setup.sh
```
`setup.sh` 실행 시 자동 완료되는 항목:
- CLAUDE.md 자동 생성 (프로젝트 이름/설명 포함)
- README.md 자동 생성 (셋업 가이드 + 환경변수 섹션)
- .gitignore 자동 생성 (.env, node_modules 등 차단)
- .env.local 생성 (.env.example 기반, 값만 채우면 됨)
- Claude Code deny 규칙 11개 (위험 명령 자동 차단)
- Claude Code hooks 2개 (lint 체크 + .env 커밋 방지)
- Claude Code commands 4개 (/dev, /build, /lint, /setup-env)
- 추천 플러그인 자동 설치 (bkit, context7, security-guidance)
- Next.js 프로젝트 스캐폴딩 (TypeScript + Tailwind + App Router, 선택)
- .editorconfig (에디터 간 코딩 스타일 통일)
- PR 템플릿 (PR 작성 양식 자동 적용)
- CI 파이프라인 (push/PR 시 lint + build 자동 검증)
- 템플릿 레포 보호 (clone 시 remote 감지 + 제거 안내)
setup.sh에서 건너뛴 항목이 있다면:
```bash
# Next.js 프로젝트 생성
pnpm create next-app . --typescript --tailwind --eslint --app --src-dir --use-pnpm
# 환경변수 설정
cp .env.example .env.local
# .env.local에 필요한 값 채우기
```
## Quick Start
```bash
pnpm install
pnpm dev
```
## Tech Stack
- Next.js 15 (App Router)
- React 19
- TypeScript 5
- Tailwind CSS 4
- pnpm
## Scripts
| 명령어 | 설명 |
|--------|------|
| `pnpm dev` | 개발 서버 (http://localhost:3000) |
| `pnpm build` | 프로덕션 빌드 |
| `pnpm lint` | ESLint 검사 |
| `pnpm format` | Prettier 포맷 |
## Environment Variables
환경변수는 `.env.local`에 저장하며, **절대 git에 커밋하지 않습니다.**
`.env.example`에 필요한 키 목록을 관리합니다:
```bash
# .env.example을 복사해서 시작
cp .env.example .env.local
```
## Claude Code
이 프로젝트는 [Claude Code](https://docs.anthropic.com/en/docs/claude-code) 최적화 설정이 포함되어 있습니다.
- `CLAUDE.md` - 프로젝트 컨텍스트
- `.claude/rules/` - 경로별 자동 규칙
- `.claude/hooks/` - 자동 검증 (TypeScript 문법, .env 커밋 방지)
- `.claude/commands/` - `/dev`, `/build`, `/lint`, `/setup-env`
## License
Private - TeamSPWK