Files
wiki/README-ko.md
T
2025-11-07 02:50:20 +09:00

2.2 KiB

Personal Wiki SPA

Microsoft Learn 스타일의 다크 테마 개인 위키 애플리케이션입니다.

기술 스택

  • 프론트엔드: React 19+ with TypeScript
  • 빌드 도구: Vite 7.1+
  • 상태 관리: TanStack React Query 5.90.7
  • 라우팅: React Router v7
  • UI 컴포넌트: Radix UI (접근성 지원)
  • 스타일링: Tailwind CSS v4
  • 아키텍처: Feature-Sliced Design (FSD)

주요 기능

  • ✅ 위키 페이지 CRUD (생성, 읽기, 수정, 삭제)
  • ✅ Microsoft Learn 스타일의 3단 레이아웃
  • ✅ 왼쪽 네비게이션 사이드바 (페이지 트리 + 실시간 검색)
  • ✅ 오른쪽 목차 사이드바 (TOC)
  • ✅ Breadcrumb 네비게이션
  • ✅ 다크 테마 UI
  • ✅ 접근성 지원 (Radix UI)
  • ✅ 클라이언트 사이드 더미 데이터

프로젝트 구조 (FSD)

src/
├── app/              # 애플리케이션 엔트리 포인트
├── entities/         # 비즈니스 도메인 모델
│   └── page/        # Page 엔티티 (타입, API)
├── features/         # 재사용 가능한 기능 모듈
│   ├── page/        # 페이지 관련 UI 컴포넌트
│   └── search/      # 검색 기능
├── pages/           # 라우팅 대상 페이지 컴포넌트
├── shared/          # 공용 모듈
└── main.tsx         # 진입점

시작하기

설치

npm install

개발 서버 실행

npm run dev

애플리케이션이 http://localhost:5173/ 에서 실행됩니다.

빌드

npm run build

프리뷰

npm run preview

사용 방법

  1. 페이지 목록: 메인 화면에서 모든 위키 페이지를 확인할 수 있습니다.
  2. 검색: 상단 검색바에서 페이지 제목이나 내용으로 검색할 수 있습니다.
  3. 새 페이지 만들기: "새 페이지" 버튼을 클릭하여 새로운 위키 페이지를 작성합니다.
  4. 페이지 보기: 목록에서 페이지를 클릭하여 상세 내용을 확인합니다.
  5. 페이지 편집: 페이지 상세 화면에서 "편집" 버튼을 클릭합니다.
  6. 페이지 삭제: 페이지 상세 화면에서 "삭제" 버튼을 클릭하고 확인합니다.

라이센스

MIT