🐦‍🔥 2024 Refactoring

⭐️ Git

🔍 브랜치 전략 및 컨벤션

1. Git Workflow

.
├── main: 배포 코드가 있는 브랜치
│    └── develop: 실제 개발 브랜치
│         ├── feature: 기능 구현 브랜치
│         ├── test: 테스트 코드 작성 브랜치
│         ├── fix: 버그 수정 브랜치
│         ├── refactor: 코드 스타일 수정 및 리팩토링을 위한 브랜치
│         └── docs: readme 등 문서를 작업하는 브랜치
└── hoxfix: main에서 버그를 수정할 브랜치

2. Branch Naming

⭐️ [해당하는 브랜치]/[front/back]-issue[이슈번호]

ex) develop
      ├── feature/front-issue25
      ├── fix/back-issue126
      └── ...

3. Commit Convention

💡 [Part] Tag: Subject

 ex) [FE] feat: 홈페이지 이미지추가

[파트] 태그: 제목의 형태로 ], : 뒤에는 space가 있다.

• feat: 기능 추가
• test: 테스트 코드 작성
• modify: 버그 아닌 코드 수정
• fix: 버그 수정
• refactor: 코드 리팩토링
• style: 코드 스타일(코드 컨벤션 추가) 수정
• docs: 문서 작업
• design: 프론트 CSS 수정
• test: 테스트 코드 작성
• chore: 프로젝트 설정 파일 수정
• create: 프로젝트 생성
• rename: 파일이나 폴더명을 수정하거나 옮기는 작업만 수행
• remove: 파일을 삭제하는 작업만 수행

---

프로젝트 개요

프롤로그는 많은 사용자들이 깃허브 블로그를 쉽게 이용할 수 있도록 도와주는 솔루션 서비스입니다.

주요기능

• 기존의 CLI 환경에서 작업하던 번거로운 작업을 GUI를 통해 편리하게 이용할 수 있도록 개발하였습니다.
• Git Actions를 활용해 변경사항을 인식하고 자동으로 빌드-배포할 수 있습니다.
• 오픈소스 테마를 활용해 다양한 테마를 지원하고 프로젝트를 확장시킬 수 있습니다.

세부기능

• 블로그

  • 블로그 생성

  • 블로그 설정

  • 블로그 배포

    
    

• 게시글

  • 게시글 목록

  • 게시글 작성

  • 게시글 수정

  • 게시글 삭제

    
    

• 레이아웃

  • 레이아웃 구조 설정
  • 레이아웃 상세 설정
    

프로젝트 빌드 방법

BackEnd

git clone  <repo URL>
cd backend/prologue
./gradlew
cd build/libs ssafy-web-project-1.0-SNAPSHOT.jar

FrontEnd

git clone  <repo URL>
cd frontend
npm install
npm start

개발자

• [BE] 윤석찬 (82chain@gmail.com)
• [BE] 권유나 (yunaghgh@gmail.com)
• [BE] 김태훈 (com151925@gmail.com)
• [FE] 강정현 (jhkang9820@gmail.com)
• [FE] 김주연 (jyeon3930@gmail.com)
• [FE] 김연수 (dustn4325@gmail.com)

아키텍처

커뮤니티 가이드

Prologue document page

• 행동강령
• 기여 가이드
• 기여 컨벤션

License

• MIT License