e34796a53f
- AI/E2E 자동화 시 URL 추측 금지, 메뉴 클릭 필수 규칙 - .gitignore에 frontend 폴더 추적 허용 - _index.md에 11번 문서 항목 추가
101 lines
4.2 KiB
Markdown
101 lines
4.2 KiB
Markdown
# SAM ERP Frontend Documentation
|
|
|
|
> **프로젝트**: SAM ERP Next.js 프론트엔드
|
|
> **최종 갱신**: 2026-03-10
|
|
> **현재 문서 버전**: v1
|
|
|
|
---
|
|
|
|
## 문서 구조
|
|
|
|
```
|
|
frontend/
|
|
├── _index.md ← 현재 문서 (목록 + 버전 관리)
|
|
├── v1/ ← 현재 활성 버전
|
|
│ ├── 01 ~ 09 ← 프론트엔드 아키텍처/가이드
|
|
│ ├── 10 ← API 연동 스펙
|
|
│ └── 11 ← 브라우저 네비게이션 규칙 (AI/자동화)
|
|
└── api-specs/ ← (레거시, v1/10으로 이관됨)
|
|
```
|
|
|
|
---
|
|
|
|
## 문서 목록 및 버전 현황
|
|
|
|
| # | 문서 | 버전 | 최종 수정 | 담당 | 대상 | 설명 |
|
|
|---|------|------|----------|------|------|------|
|
|
| 01 | [architecture](v1/01-architecture.md) | 1.0.0 | 2026-03-09 | Frontend | 전체 | 프로젝트 구조, 기술 스택, 디렉토리 설계 |
|
|
| 02 | [api-pattern](v1/02-api-pattern.md) | 1.0.0 | 2026-03-09 | Frontend | FE/BE | API 통신 패턴 (프록시, Server Action, buildApiUrl) |
|
|
| 03 | [component-design](v1/03-component-design.md) | 1.0.0 | 2026-03-09 | Frontend | FE/기획 | 컴포넌트 계층 (atoms → templates), 페이지 유형 |
|
|
| 04 | [common-components](v1/04-common-components.md) | 1.0.0 | 2026-03-09 | Frontend | FE | 공통 컴포넌트 사용법 (UniversalListPage 등) |
|
|
| 05 | [form-pattern](v1/05-form-pattern.md) | 1.0.0 | 2026-03-09 | Frontend | FE | 폼 패턴 (Zod, FormField, react-hook-form) |
|
|
| 06 | [styling-guide](v1/06-styling-guide.md) | 1.0.0 | 2026-03-09 | Frontend | FE/디자인 | CSS 규칙 (Tailwind, shadcn/ui, 색상 시스템) |
|
|
| 07 | [auth-flow](v1/07-auth-flow.md) | 1.0.0 | 2026-03-09 | Frontend | FE/BE | 인증 흐름 (HttpOnly cookie, 토큰 갱신) |
|
|
| 08 | [dashboard-system](v1/08-dashboard-system.md) | 1.0.0 | 2026-03-09 | Frontend | FE/BE | CEO 대시보드 아키텍처 (invalidation, hooks) |
|
|
| 09 | [conventions](v1/09-conventions.md) | 1.0.0 | 2026-03-09 | Frontend | FE | 네이밍, import, 파일 배치, Git 규칙 |
|
|
| 10 | [document-api-integration](v1/10-document-api-integration.md) | 1.0.0 | 2026-02-05 | API Team | FE/BE | 문서 관리 API 연동 (검사 성적서 resolve/upsert) |
|
|
| 11 | [browser-navigation-rules](v1/11-browser-navigation-rules.md) | 1.0.0 | 2026-03-10 | Frontend | AI/QA | 브라우저 네비게이션 규칙 (URL 추측 금지, 메뉴 클릭 필수) |
|
|
|
|
### 대상 범례
|
|
- **FE**: 프론트엔드 개발자
|
|
- **BE**: 백엔드 개발자
|
|
- **기획**: 기획자/PM
|
|
- **디자인**: 디자이너
|
|
- **전체**: 모든 역할
|
|
|
|
---
|
|
|
|
## 버전 변경 이력
|
|
|
|
### v1 (2026-03-09 ~)
|
|
|
|
| 날짜 | 문서 | 변경 | 버전 |
|
|
|------|------|------|------|
|
|
| 2026-03-09 | 01~09 | 초기 작성 | 1.0.0 |
|
|
| 2026-02-05 | 10 | 문서 API 연동 가이드 작성 (api-specs에서 이관) | 1.0.0 |
|
|
| 2026-03-10 | 11 | 브라우저 네비게이션 규칙 추가 (AI/E2E URL 추측 금지) | 1.0.0 |
|
|
|
|
---
|
|
|
|
## 버전 관리 규칙
|
|
|
|
### 문서 버전 (Semantic Versioning)
|
|
|
|
```
|
|
MAJOR.MINOR.PATCH
|
|
|
|
MAJOR: 문서 구조 변경, 기존 내용 대폭 수정
|
|
MINOR: 새로운 섹션 추가, 기존 내용 보완
|
|
PATCH: 오탈자, 코드 예시 수정, 사소한 수정
|
|
```
|
|
|
|
### 업데이트 절차
|
|
|
|
1. 해당 문서 내용 수정
|
|
2. 문서 상단 `버전`과 `최종 수정` 날짜 갱신
|
|
3. 이 `_index.md`의 문서 목록 테이블 버전/날짜 갱신
|
|
4. 변경 이력 테이블에 행 추가
|
|
|
|
### 새 문서 추가 시
|
|
|
|
1. `v1/` 폴더에 `{번호}-{주제}.md` 형식으로 생성
|
|
2. 문서 상단에 버전/날짜/대상 헤더 포함
|
|
3. `_index.md` 문서 목록 테이블에 행 추가
|
|
|
|
---
|
|
|
|
## 빠른 참고
|
|
|
|
| 할 일 | 읽을 문서 |
|
|
|-------|----------|
|
|
| 프로젝트 전체 구조 이해 | 01-architecture |
|
|
| API 호출 방법 알기 | 02-api-pattern |
|
|
| 새 리스트 페이지 만들기 | 03-component-design → 04-common-components |
|
|
| 새 폼 페이지 만들기 | 05-form-pattern |
|
|
| 디자인/스타일 규칙 확인 | 06-styling-guide |
|
|
| 인증 동작 이해 | 07-auth-flow |
|
|
| 대시보드 연동 작업 | 08-dashboard-system |
|
|
| 코딩 컨벤션 확인 | 09-conventions |
|
|
| 문서 관리 API 연동 | 10-document-api-integration |
|
|
| AI/E2E 페이지 이동 규칙 | 11-browser-navigation-rules |
|