Skip to content
박주형 edited this page Apr 6, 2024 · 4 revisions

DRF 블로그 프로젝트

이 프로젝트는 Django REST Framework(DRF)를 사용하여 블로그 웹 애플리케이션과 부트스트랩 기반 랜딩 페이지를 구축하는 것을 목표로 합니다. 프로젝트에는 다음과 같은 주요 기능이 포함됩니다.

  • 사용자 인증 및 프로필 관리
  • 게시글 CRUD (작성, 읽기, 수정, 삭제)
  • 카테고리 관리
  • 댓글 및 대댓글 CRUD
  • 검색 및 필터링
  • 파일 및 이미지 업로드
  • 포스팅 권한 관리

팀 구성

  • 기획자 1명 (기획)
  • 개발리드 1명 (FE, BE(posts 앱))
  • 백엔드 개발자 3명 (accounts 앱, comment 앱, AI 챗봇 담당)

컨벤션 및 규칙

이 프로젝트에서 따르는 주요 규칙과 컨벤션은 다음과 같습니다.

코딩 컨벤션

  • Black Formatter, isort, flake8
  • Prettier

Git 브랜치 전략

  • main 브랜치: 배포 가능한 코드만 있어야 함
  • 기능 브랜치 이름: feature/기능
  • 문서 브랜치 이름: docs/문서 이름

Pull Request 규칙

  • 작업 완료 후 main 브랜치에 Pull Request 요청
  • 최소 1명 이상의 코드 리뷰 후 승인되면 main 브랜치에 병합
  • 필요에 따라 로컬 및 원격 저장소에서 해당 브랜치 삭제
  • PR 제목은 의미 있게 작성하고, 본문에 작업 내용 기술

테스트 및 문서화

  • 주요 기능에 대해 단위 테스트 코드 작성
  • API 문서화를 위해 Swagger 또는 drf-spectacular 사용

프로젝트 구조

  • accounts 앱: 사용자 인증 및 프로필 관리
  • comments 앱: 댓글/대댓글 CRUD
  • config 앱: 프로젝트 기본 세팅
  • posts 앱: 게시글 CRUD