[ 2024.09.13 TIL ] Futsal-manager

박지영·2024년 9월 13일
0

Today I Learned

목록 보기
45/67
post-thumbnail

⚽ Futsal-manager

📌 사용 기술 스택

Node.js

  • express

패키지 매니저

  • yarn

데이터베이스

  • MySQL - AWS RDS

ORM

  • Prisma - MySQL

🎈 배포

  • AWS EC2

🎫 인증

  • req의 authrization header JWT 베어러-토큰

🎨 와이어 프레임

https://www.figma.com/board/Gcd6AzmTOjaDKNC2pqe3IL/풋살-온라인?node-id=0-1&node-type=canvas&t=Ud4obTUk64JFsNwJ-0

🧾 API 명세서


🖥 데이터베이스 모델링

🧱 초기 설정

📖 초기 디렉토리 구조

📃 package.json

🔒 커밋 컨벤션

🔒 코드 컨벤션

1. 네이밍 컨벤션 (Naming Conventions)

  • 파일 및 디렉토리 이름: 소문자, 언더스코어
  • 클래스 및 인터페이스 이름: PascalCase 사용 여부.
  • 메서드 및 함수 이름: camelCase
  • 변수 이름: 지역 변수와 전역 변수의 네이밍 규칙. camelCase
  • 상수 이름: 대문자와 언더스코어 사용 (예: MAX_VALUE).

2. 코드 포매팅 (Code Formatting)

  • Prettier 설정 사용

3. 주석 및 문서화 (Comments and Documentation)

  • 주석 스타일: 한 줄일 때는 단일 행(//), 여러줄일 경우 다중 행(/* */) 주석의 사용
  • 문서화 주석: jsdoc
  • 주석 내용: 하는 역할

4. API 설계 (API Design)

  • 엔드포인트 네이밍: RESTful한 URL 설계 규칙.
  • HTTP 메서드 사용: GET, POST, PATCH, DELETE의 사용 기준.
  • 응답 구조: 성공 및 에러 응답 형식과 코드.

5. 의존성 관리 (Dependency Management)

  • 패키지 매니저 사용: yarn

6. 배포 및 환경 설정 (Deployment and Environment Configuration)

  • 환경 변수 관리: .env

7. 협업 규칙 (Collaboration Rules)

  • 커뮤니케이션 채널: 슬랙

📌 맡은 기능

  • 나만의 팀 꾸리기 기능
    보유 선수 목록의 선수 3명을 골라 라인업으로 설정, 설정한 선수들로 경기 진행
    보유 선수가 3명 미만인 경우 팀 꾸리기 불가능
profile
신입 개발자

0개의 댓글