스타게이트

관리자 관점 시연영상

팬 관점 시연영상

Guide

User

1. 로그인을 통해 대시보드 페이지에 입장한다.
2. 대시보드 페이지 상단에 있는 오픈되어 있는 팬사인회에 입장한다.
3. 팬사인회 대기 진입화면에서 공지사항, 화면 테스트, 폴라로이드 촬영 옵션 선택 등을 진행한다.
4. 대기화면에서 대기하다가 시간이 되면 화상통화 창으로 진입해서 팬사인회에 참가한다.
5. 팬사인회가가 모두 마무리 되면 촬영한 사진을 확인하고 편지를 보낸다.

Admin

1. 로그인을 통해 대시보드 페이지에 입장한다.
2. 대시보드 페이지 우측 하단에 있는 버튼을 눌러 새로운 팬사인회를 생성페이지로 이동한다.
3. 날짜, 시간, 진행 시간 등의 옵션과 참여할 그룹과 멤버, 그리고 User 리스트를 추가한 뒤, 팬사인회를 생성한다.
4. 팬사인회 상세 페이지에서 접속 URL을 가져와 Star에게 전달한다.
5. 팬사인회가 종료된 후에 팬들의 편지 리스트를 확인하고 전달한다.

Star

1. Admin에게 접속할 URL을 전달받는다.
2. 화상통화 창으로 진입해서 팬사인회에 참가한다.

Contents

0. Dev 서버 구동방법
1. 개발 배경
2. Solution
3. Skills
4. architecture
5. Folder Structure
6. Team
7. Project Control
8. Code Convention
9. Challenges

Dev 서버 구동방법

아래 코드를 터미널에 붙여넣습니다.

git clone

git clone https://lab.ssafy.com/s09-webmobile1-sub2/S09P12A406.git

pnpm 설치

npm i -g pnpm

node_modules 설치

pnpm install

Dev 서버 구동

pnpm run dev

개발 배경

Solution

User

Admin

architecture

Sequence Diagram

Folder Structure

Frontend

Frontend에서는 Atomic Design Pattern을 커스텀하여 Atoms, Organisms, Pages 3단계로 나눠서 구현하였습니다.

Atom : 더 이상 분해할 수 없는 기본 컴포넌트
Organism : 하나 이상의 Atom을 조합
Page : 비즈니스 로직을 관리, 하위 단위에서 필요한 상태값들을 props로 전달.

C:.
├─public    
└─src
    ├─assets
    │  ├─font    
    │  └─image     
    ├─atoms
    │  ├─auth
    │  ├─board
    │  ├─common
    │  ├─event
    │  └─remind
    ├─hooks
    ├─organisms
    │  ├─auth
    │  ├─board
    │  └─event
    └─pages
        ├─auth
        ├─star
        ├─admin
        │  ├─board
        │  ├─event
        │  └─signUp
        └─user
            ├─board
            └─video

Backend

C:.
├─main
│  ├─java
│  │  └─com
│  │      └─ssafy
│  │          └─stargate
│  │              ├─advice
│  │              ├─config
│  │              ├─controller
│  │              ├─exception
│  │              ├─filter
│  │              ├─handler
│  │              ├─model
│  │              │  ├─dto
│  │              │  │  ├─common
│  │              │  │  ├─request
│  │              │  │  └─response
│  │              │  ├─entity
│  │              │  ├─repository
│  │              │  └─service
│  │              └─util
│  └─resources
└─test
    └─java
        └─com
            └─ssafy
                └─stargate

Skills

Frontend

• React
  • Recoil
• TypeScript
• Tailwind CSS
• Axios
• pnpm
• Vite

Backend

• Java
• Spring Boot
• Gradle
• dependencies
  • WebSocket
  • Spring Security
  • JPA
  • Validation
• MySQL

Server

• AWS EC2
• Docker Desktop

Team

이의찬 (Front-end)	정예륜 (Front-end)	이유한 (Front-end)
백승윤 (Back-end)	남현실 (Back-end)	김도현 (Back-end)

Project Control

Version Control: Git, GitLap

Task Control: Notion, Figma, Jira, Slack

Code Convention

Part별 Code Convention은 노션에 작성했습니다.

Frontend

Backend

GIT 커밋 컨벤션

Word	Description
feature	새로운 기능 추가
fix	버그 수정
build	빌드 관련 파일 수정, 패키지 매니저 수정
refactor	코드를 리팩토링 할 때
style	코드 포맷팅, 세미콜론 누락, 코드 변경이 없는 경우
chore	사소한 코드 또는 언어를 변경할 때
test	테스트 코드, 리펙토링 테스트 코드 추가
docs	문서를 쓸 때

Commit Message Structure

기본적으로 커밋 메세지는 아래와 같이 제목/본문/꼬리말로 구성한다

type : subject

body

feat: Summarize changes in around 50 characters or less [#123, #456, #789]

More detailed explanatory text, if necessary. Wrap it to about 72
characters or so. In some contexts, the first line is treated as the
subject of the commit and the rest of the text as the body. The
blank line separating the summary from the body is critical (unless
you omit the body entirely); various tools like `log`, `shortlog`
and `rebase` can get confused if you run the two together.

Explain the problem that this commit is solving. Focus on why you
are making this change as opposed to how (the code explains that).
Are there side effects or other unintuitive consequenses of this
change? Here's the place to explain them.

Further paragraphs come after blank lines.

 - Bullet points are okay, too

 - Typically a hyphen or asterisk is used for the bullet, preceded
   by a single space, with blank lines in between, but conventions
   vary here

If you use an issue tracker, put references to them at the bottom,
like this:

• type
  • 과거시제 사용하지 않고 명령어로 작성
    • fix, add …
• subject
  • 50자 이하
• body (선택사항)
  • 부연설명이 필요하거나 커밋의 이유를 설명할 경우 작성
  • 72자를 넘기지 않고 제목과 구분되기 위해 한칸 띄어 작성

PR / MR 가이드

• Merge 형식

  • 제목

    • **기능: 작업내역[JIRA 티켓]**
    • ex) refactor: auth 페이지 사용하지 않는 변수 제거 [COMMWEBFNT-217]

  • 내용

    ### Description
    
    설명
    
    ### Changes
    
    변경사항
    
    ### Test Checklist
    
    테스트 항목
    

• master, develop branch에는 commit할 수 없습니다.

• master는 prod에 배포하는 branch이기 때문에 주의해주세요.

branch

{fe/be}/{type}/{word}

코드 리뷰 룰

• 1일 1Merge를 지향합니다.

• PR을 Merge 하기 위해선 반드시 1명 이상의 코드 리뷰어가 필요합니다.

  • 코드 리뷰어는 코드리뷰어를 지정해서 Assignees으로 지정합니다 .

• 오전 코어 코드리뷰 시간에 집중해서 코드리뷰를 작성합니다.

• 코드 리뷰는 부담없이 자유로운 분위기 속에서 진행합니다.

• 리뷰 내용은 아래 사항을 고려하여 작성합니다.

  1. 코드의 일관성 유지
  2. 로직 더블체크
  3. 코드 중복 제거
  4. 함께 성장
  

Challenges

FE folder architecture

Before

C:.
├─public    
└─src
    ├─assets
    │  ├─font    
    │  └─image     
    ├─atoms 
    ├─hooks    
    ├─organisms
    └─pages
        ├─auth
        ├─star
        ├─admin
        │  ├─board
        │  ├─event
        │  └─signUp
        └─user
            ├─board
            └─video

after

C:.
├─public    
└─src
    ├─assets
    │  ├─font    
    │  └─image     
    ├─atoms
    │  ├─auth
    │  ├─board
    │  ├─common
    │  ├─event
    │  └─remind
    ├─hooks
    ├─organisms
    │  ├─auth
    │  ├─board
    │  └─event
    └─pages
        ├─auth
        ├─star
        ├─admin
        │  ├─board
        │  ├─event
        │  └─signUp
        └─user
            ├─board
            └─video

처음에는 상위 컴포넌트에서의 재사용성을 높이기 위해 atoms와 organisms만을 만들어두고 내부를 플랫하게 사용하였습니다.
작업이 진행되며 지나치게 atoms와 organisms가 늘어났고, 이에 대한 불편함도 늘어났습니다.

이에 FE팀은 폴더 구조를 수정하기로 결정하였고, 계층을 우선으로 분리하는 계층 - 기능 구조와 기능을 우선으로 분리하는 기능 - 계층 구조 중 무엇을 선택할지에 대한 논의가 있었습니다.

이미 Atomic한 구조를 사용하기로 합의하였고, UI 역시도 Atomic Design Pattern에 알맞게 작성된 상태였기에 좀 더 Atomic한 계층 - 기능 구조로 폴더 구조를 변경하였습니다.
자세한 과정에 대해서는 Blog에 작성했습니다.

기타 이슈 및 에러 해결에 대해 노션에 작성했습니다.

Frontend

Backend