shindonghyeo-ui 0.1.0 → 0.1.1
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 +20 -1
- package/package.json +19 -2
package/README.md
CHANGED
|
@@ -4,6 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
- **디자인 토큰:** 색, 글꼴, 모서리 둥글기, 레이아웃 폭을 CSS 변수(`--sd-*`)로 정의하고, 라이트/다크 모드를 지원합니다.
|
|
6
6
|
- **React 컴포넌트:** CSS Modules로 스타일을 입혀서 런타임 비용이 없고, Next.js·Astro·Vite 어디서나 동작합니다.
|
|
7
|
+
**컴포넌트 미리보기:** https://shindonghyeo.github.io/shindonghyeo-ui/ (Storybook)
|
|
8
|
+
|
|
7
9
|
- **서버 렌더링 대응:** 상호작용이 필요한 컴포넌트(`ThemeToggle`, `Toc`, `ReadingProgress`)에만 `'use client'`가 붙어 있습니다.
|
|
8
10
|
|
|
9
11
|
## 설치
|
|
@@ -116,11 +118,28 @@ import Link from 'next/link';
|
|
|
116
118
|
|
|
117
119
|
```bash
|
|
118
120
|
npm install
|
|
119
|
-
npm run
|
|
121
|
+
npm run storybook # Storybook에서 컴포넌트별로 확인 (http://localhost:6006)
|
|
122
|
+
npm run dev # 플레이그라운드(playground/)에서 한 화면으로 확인
|
|
120
123
|
npm run typecheck
|
|
121
124
|
npm run build # dist/에 JS, 타입, styles.css 생성
|
|
122
125
|
```
|
|
123
126
|
|
|
127
|
+
## 배포
|
|
128
|
+
|
|
129
|
+
main 브랜치에 반영되면 GitHub Actions([`release.yml`](.github/workflows/release.yml))가 타입 검사와 빌드를 하고, `package.json`의 버전이 npm에 아직 없을 때만 자동으로 배포한 뒤 `v버전` 태그를 올립니다. 버전을 올리지 않은 변경은 배포되지 않습니다.
|
|
130
|
+
|
|
131
|
+
새 버전을 내려면 버전만 올려서 main에 반영하면 됩니다.
|
|
132
|
+
|
|
133
|
+
```bash
|
|
134
|
+
npm version patch --no-git-tag-version # 0.1.0 → 0.1.1 (기능 추가는 minor, 호환이 깨지는 변경은 major)
|
|
135
|
+
git commit -am "0.1.1"
|
|
136
|
+
git push
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
Storybook은 main에 반영될 때마다 [`storybook.yml`](.github/workflows/storybook.yml)이 GitHub Pages에 다시 올립니다. 새 컴포넌트를 만들면 `stories/`에 스토리 파일도 함께 추가해 주세요.
|
|
140
|
+
|
|
141
|
+
npm 인증은 [Trusted Publishing](https://docs.npmjs.com/trusted-publishers)을 써서 저장해 둔 토큰이 없습니다.
|
|
142
|
+
|
|
124
143
|
## 라이선스
|
|
125
144
|
|
|
126
145
|
MIT
|
package/package.json
CHANGED
|
@@ -1,9 +1,21 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "shindonghyeo-ui",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "신동혁의 개인 React 디자인 시스템",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"react",
|
|
7
|
+
"design-system",
|
|
8
|
+
"components",
|
|
9
|
+
"ui",
|
|
10
|
+
"css-modules",
|
|
11
|
+
"storybook"
|
|
12
|
+
],
|
|
5
13
|
"license": "MIT",
|
|
6
14
|
"author": "Donghyeok Shin",
|
|
15
|
+
"homepage": "https://shindonghyeo.github.io/shindonghyeo-ui/",
|
|
16
|
+
"bugs": {
|
|
17
|
+
"url": "https://github.com/SHINDongHyeo/shindonghyeo-ui/issues"
|
|
18
|
+
},
|
|
7
19
|
"repository": {
|
|
8
20
|
"type": "git",
|
|
9
21
|
"url": "git+https://github.com/SHINDongHyeo/shindonghyeo-ui.git"
|
|
@@ -28,18 +40,23 @@
|
|
|
28
40
|
"dev": "vite",
|
|
29
41
|
"build": "vite build",
|
|
30
42
|
"typecheck": "tsc --noEmit",
|
|
31
|
-
"prepare": "npm run build"
|
|
43
|
+
"prepare": "npm run build",
|
|
44
|
+
"storybook": "storybook dev -p 6006",
|
|
45
|
+
"build-storybook": "storybook build -o storybook-static"
|
|
32
46
|
},
|
|
33
47
|
"peerDependencies": {
|
|
34
48
|
"react": ">=18",
|
|
35
49
|
"react-dom": ">=18"
|
|
36
50
|
},
|
|
37
51
|
"devDependencies": {
|
|
52
|
+
"@storybook/addon-docs": "^10.6.5",
|
|
53
|
+
"@storybook/react-vite": "^10.6.5",
|
|
38
54
|
"@types/react": "^19.3.0",
|
|
39
55
|
"@types/react-dom": "^19.3.0",
|
|
40
56
|
"@vitejs/plugin-react": "^6.1.2",
|
|
41
57
|
"react": "^19.3.1",
|
|
42
58
|
"react-dom": "^19.3.1",
|
|
59
|
+
"storybook": "^10.6.5",
|
|
43
60
|
"typescript": "^6.0.3",
|
|
44
61
|
"vite": "^8.3.5",
|
|
45
62
|
"vite-plugin-dts": "^5.1.2"
|