Skip to content

ready-oun/oz_team_project_red_ribbon

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 

Repository files navigation

📖 프로젝트 소개

🎀 Red-Ribbon 과 함께 현명한 소비생활 🎀

📌 자신만의 한달 예산과 고정지출을 정하고 나의 소비를 작성하고 👩🏻‍💻

📌 자신의 소비습관을 확인해보세요 😊

현명한 소비 습관을 만들어주는 서비스, Red-Ribbon에 오신 걸 환영합니다!

🔗 배포 링크


🗣️ 프로젝트 발표 영상 & 발표 문서

🗓️ 2024.04.01 - 2024.04.30


🖥️ 서비스 소개

회원가입 일반 로그인 소셜 로그인 1
회원가입-5 일반로그인 소셜로그인1
소셜 로그인 2 전체예산 등록/수정/삭제 고정지출 등록/수정/삭제
소셜로그인2 예산등록-수정-삭제 고정지출등록-수정-삭제
지출 등록/수정/삭제 메인 페이지 1 메인 페이지 2
지출등록-수정-삭제 메인페이지1 메인페이지2
보고서 조회 회원정보 프로필 사진 업로드 / 로그아웃 회원정보 수정 및 회원 탈퇴
보고서 회원정보-프로필사진-업로드-로그아웃 회원정보수정-탈퇴

🧰 사용 스택

🔧 System Architecture

Red Ribbon Architecture

FE




BE




협업 툴



👥 팀 동료

FE


@deswaq1220


@jhsonnn


@pparksse1

변경원 손지형 박세원

BE


@SwanyCastle


@ready-oun

곽승환 임희연

📑 프로젝트 규칙

Branch Strategy

  • main / devlop 브랜치 기본 생성
  • main과 dev로 직접 push 제한
  • PR 전 최소 1인 이상 승인 필수

Git Convention

  1. 적절한 커밋 접두사 작성
  2. 커밋 메시지 내용 작성
  3. 내용 뒤에 이슈 (#이슈 번호)와 같이 작성하여 이슈 연결
접두사 설명
Feat : 새로운 기능 구현
Add : 에셋 파일 추가
Fix : 버그 수정
Docs : 문서 추가 및 수정
Style : 스타일링 작업
Refactor : 코드 리팩토링 (동작 변경 없음)
Test : 테스트
Deploy : 배포
Conf : 빌드, 환경 설정
Chore : 기타 작업

Pull Request

Title

  • 제목은 '[Feat] 홈 페이지 구현'과 같이 작성합니다.

PR Type

  • FEAT: 새로운 기능 구현
  • ADD : 에셋 파일 추가
  • FIX: 버그 수정
  • DOCS: 문서 추가 및 수정
  • STYLE: 포맷팅 변경
  • REFACTOR: 코드 리팩토링
  • TEST: 테스트 관련
  • DEPLOY: 배포 관련
  • CONF: 빌드, 환경 설정
  • CHORE: 기타 작업

Description

  • 구체적인 작업 내용을 작성해주세요.
  • 이미지를 별도로 첨부하면 더 좋습니다 👍

Discussion

  • 추후 논의할 점에 대해 작성해주세요.

Code Convention

BE

  • 패키지명 전체 소문자
  • 클래스명, 인터페이스명 Snake_Case
  • 클래스 이름 명사 사용
  • 상수명 SNAKE_CASE
  • Test 클래스는 접두사로 test_ 사용(ex. test_user_create())

FE

  • styled-Component 변수명 S + 변수명 (ex. Swrap)
  • styled-Component는 return문 위에 작성
  • 크게는 styled-Component, 그 안에서 className 사용
  • Event handler 사용 (ex. handle ~)
  • export방식 (ex. export default ~)
  • 화살표 함수 사용

Communication Rules

  • Discord 활용
  • 정기 회의

📋 Documents

📜 API 명세서

📜 요구사항 정의서

📜 ERD

📜 테이블 명세서

📜 화면 정의서

Packages

No packages published

Languages

  • TypeScript 65.5%
  • Python 24.2%
  • CSS 6.2%
  • JavaScript 3.6%
  • Dockerfile 0.2%
  • HTML 0.2%
  • Shell 0.1%