Skip to content

prgrms-fe-devcourse/FE7-Project1-404-1

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

98 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

FE7-Project1-404-1

주요 기능

1. 문서 관리

  • 루트 문서 생성
  • 하위 문서 생성
  • 문서 제목 및 내용 수정
  • 실시간 자동 저장 (디바운싱 적용)

2. 페이지 네비게이션

  • History API를 활용한 SPA 라우팅 구현
  • 사이드바를 통한 문서 목록 표시
  • 사이드바 토글 기능

기술 스택

  • Vaniila JavaScript
  • HTML5
  • CSS

🧱 폴더 구조

notion-clone/
├─ index.html                # 앱 진입 HTML (최소 마크업)
├─ src/
│  ├─ api/
│  │  └─ http.js            # 공통 fetch 유틸 (x-username, 에러 처리)
│  ├─ router/
│  │  └─ index.js           # History/Hash 라우팅 헬퍼
│  ├─ components/
│  │  ├─ Sidebar.js         # 문서 트리 렌더/네비게이션
│  │  └─ Editor.js          # 제목/본문 표시 + 자동 저장
│  ├─ store/                # (선택) 전역 상태/이벤트 버스
│  ├─ styles/
│  │  └─ global.css         # 기본 레이아웃/타이포/유틸
│  └─ main.js               # 앱 엔트리: 초기 렌더/라우팅 바인딩
├─ public/                   # (선택) 정적 리소스
├─ docs/                     # 아키텍처/ERD/플로우 문서
│  ├─ architecture.md
│  ├─ erd.md
│  └─ flows.md
├─ .gitignore
├─ package.json
└─ README.md

디렉터리 가이드

  • src/api: 외부 통신만. 컴포넌트 로직/DOM 접근 금지.

  • src/router: URL ↔ 화면 동기화만. 컴포넌트 직접 참조 금지.

  • src/components: 화면 조각. 입출력(파라미터/이벤트) 명확히.

  • src/store: 전역 상태가 필요할 때만 도입(초기엔 생략 가능).

  • src/styles: reset/normalize 후 공통 유틸과 레이아웃 우선.


🧾 커밋 메시지 규칙 (이모지 + 한글)

<type>: <짧은 설명> (선택: #이슈번호)
  • feat: 사용자 기능 추가

  • fix: 버그 수정

  • chore: 설정/빌드/보일러플레이트

  • style: 코드 스타일(동작 무관)

  • refactor: 리팩토링

  • docs: 문서 변경

  • test: 테스트


🗂️ 이슈 & PR 규칙

  • 이슈 템플릿(요약/작업 내용/예상 결과/스크린샷/체크리스트)

  • PR 템플릿(작업 내용/작동 방식/확인 사항/스크린샷)

  • PR 제목: [Feature] ..., [Fix] ..., [Chore] ...

  • 본문 끝에 Closes #이슈번호로 자동 종료 연결


🔌 API 사용 규칙

  • 모든 요청 헤더 포함:
x-username: <고유 이름>
Content-Type: application/json
  • 엔드포인트

    • GET /documents : 루트 트리

    • GET /documents/:id : 단건 조회

    • POST /documents : 생성 { title, parent }

    • PUT /documents/:id : 수정 { title, content }

    • DELETE /documents/:id : 삭제

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •