Skip to content

NOW-SOPT-CDSP-WEB3/client

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ’³ ν˜„λŒ€ μΉ΄λ“œ πŸ’³

NOW SOPT WEB TEAM 3
image

πŸ“Œ 합동 μ„Έλ―Έλ‚˜ - ν˜„λŒ€ μΉ΄λ“œ

  • λ””μžμΈ νŒŒνŠΈμ›λ“€μ΄ UXκ°œμ„ μ„ μœ„ν•΄ 기쑴의 μ„œλΉ„μŠ€λ₯Ό λ¦¬λ””μžμΈ ν•΄μ˜¨ 것을 μ„œλ²„νŒŒνŠΈμ™€ ν•¨κ»˜ ν˜‘μ—…ν•˜μ—¬ κ΅¬ν˜„ν•˜κ³  λ””μžμΈ 파트, κΈ°νšνŒŒνŠΈμ™€ ν˜‘μ—…μ„ κ²½ν—˜ν•΄λ³Ό 수 μžˆλŠ” μ„Έλ―Έλ‚˜μž…λ‹ˆλ‹€.
  • μ›Ή 3νŒ€μ€ ν˜„λŒ€μΉ΄λ“œ λ¦¬λ””μžμΈμ€ μ§„ν–‰ν–ˆμ–΄μš”!

πŸ›  κΈ°μˆ μŠ€νƒ

μ—­ν•  μ’…λ₯˜
Library React VITE
Programming Language TypeScript
Styling Styled components
Data Fetching Axios ReactQuery
Formatting ESLint Prettier Stylelint
Package Manager Yarn
Version Control Git GitHub

🌳 κ΅¬ν˜„ View

🌿 Main View

homepage_1 homepage_2

🌿 Card View

cardpage_1 cardpage_2

🌿 Benefit View

benefitpage_1 benefitpage_2

🌿 Culture View

culturepage_1 homepage_2

1️⃣ Commit μ»¨λ²€μ…˜

commit κ·œμΉ™

ν‚€μ›Œλ“œ: λ‚΄μš©

  • μ˜ˆμ‹œ:
    • init: 초기 μ„ΈνŒ…
    • feat: κΈ°λŠ₯ 개발

Commit λ©”μ‹œμ§€ μ’…λ₯˜ μ„€λͺ…

제λͺ© λ‚΄μš©
feat μƒˆλ‘œμš΄ κΈ°λŠ₯을 μΆ”κ°€ν•  경우
style κΈ°λŠ₯에 영ν–₯을 주지 μ•ŠλŠ” 컀밋, μ½”λ“œ μˆœμ„œ, css λ“±μ˜ 포맷에 κ΄€ν•œ 컀밋
fix 버그λ₯Ό 고친 경우
refactor ν”„λ‘œλ•μ…˜ μ½”λ“œ λ¦¬νŒ©ν† λ§
docs λ¬Έμ„œλ₯Ό μˆ˜μ •ν•œ 경우, 파일 μ‚­μ œ, 파일λͺ… μˆ˜μ • λ“± ex) README.md
chore λΉŒλ“œ ν…ŒμŠ€νŠΈ μ—…λ°μ΄νŠΈ, νŒ¨ν‚€μ§€ λ§€λ‹ˆμ €λ₯Ό μ„€μ •ν•˜λŠ” 경우, 주석 μΆ”κ°€, μžμž˜ν•œ λ¬Έμ„œ μˆ˜μ •
code review μ½”λ“œ 리뷰 반영
2️⃣ Branch μ „λž΅

브랜치 μ „λž΅

feat/#이슈번호/μ΄μŠˆμ΄λ¦„

Git Branch

  • GitHub-Flow μ „λž΅ + develop
  • 브랜치 운영
    • feat/#이슈번호/μ΄μŠˆμ΄λ¦„ (camelCase): κΈ°λŠ₯을 κ°œλ°œν•˜λ©΄μ„œ κ°μžκ°€ μ‚¬μš©ν•œ 브랜치
      • main: μ™„μ „νžˆ μ•ˆμ „ν•˜λ‹€κ³  νŒλ‹¨λ˜μ—ˆμ„ λ•Œ, 즉 배포가 κ°€λŠ₯ν•œ μ΅œμ’… mergeν•˜λŠ” 브랜치
      • develop: λ°°ν¬ν•˜κΈ° μ „ 개발 쀑일 λ•Œ 각자의 λΈŒλžœμΉ˜μ—μ„œ mergeν•˜λŠ” 브랜치 (default 브랜치)
        • feat/#이슈번호/κΈ°λŠ₯λͺ…: feature 브랜치. μƒˆλ‘œμš΄ κΈ°λŠ₯ 개발. 개발이 μ™„λ£Œλ˜λ©΄ develop 브랜치둜 병합
        • fix/#이슈번호/κΈ°λŠ₯λͺ…: feature 브랜치 생성 ν›„ 버그가 생겼을 λ•Œ μˆ˜μ •ν•˜λŠ” 브랜치
        • κ·Έ μ™Έ hotfix, release 등은 μ‚¬μš© X
3️⃣ μ½”λ”© μ»¨λ²€μ…˜
  1. λ³€μˆ˜λͺ…, ν•¨μˆ˜λͺ…을 고민을 μš°μ„ μ μœΌλ‘œ ν•˜λ˜, 주석이 ν•„μš”ν•œ κ²½μš°λŠ” μ–΄λ–€ 역할을 ν•˜λŠ”μ§€ λ‹€λ₯Έ μ‚¬λžŒμ΄ 이해할 수 μžˆλ„λ‘ μž‘μ„±ν•˜μž

  2. ν•΄μ•Ό ν•  사항이 μžˆλ‹€λ©΄ // TODO: μ£Όμ„μœΌλ‘œ ν‘œμ‹œν•˜μž

  3. μ»΄ν¬λ„ŒνŠΈ 파일의 ν™•μž₯μžλŠ” .tsx, .jsx둜 μ •ν•œλ‹€

  4. μ»΄ν¬λ„ŒνŠΈμ™€ 일반 κΈ°λŠ₯을 κ΅¬ν˜„ν•˜λŠ” ν•¨μˆ˜ ꡬ뢄

    • μ»΄ν¬λ„ŒνŠΈ: 일반 ν•¨μˆ˜ function을 μ‚¬μš©

      // Bad
      const skrr = () => {
          return <div>skrr</div>
      }
      
      export default skrr
      
      // Good
      function skrr() {
          return <div>skrr</div>
      }
      
      export default skrr
    • κΈ°λŠ₯을 κ΅¬ν˜„ν•˜λŠ” ν•¨μˆ˜: constλ₯Ό μ‚¬μš©

      // Bad
      function handleskrr(number) {
          return number + 1
      }
      
      // Good
      const handleSkrr = (number) => {
          return number + 1
      }

  5. λ³€μˆ˜/ν•¨μˆ˜λͺ…은 20자 미만, μ£Όμ„μœΌλ‘œ λ³€μˆ˜ μ„€λͺ…

    • λ³€μˆ˜/ν•¨μˆ˜λͺ…은 이해할 수 μžˆμ„ μ •λ„λ‘œ κ³ λ―Ό

      // Bad
      const isLoading = true;
      
      // Good
      const isUserDataLoading = true;
    • λŒ€λΆ€λΆ„μ˜ 경우 카멜 μΌ€μ΄μŠ€λ₯Ό μ‚¬μš©

      // Bad
      const is_snake_case = 'Bad';
      
      // Good
      const camelCase = 'Good';
    • μƒμˆ˜λŠ” 영문 λŒ€λ¬Έμž μŠ€λ„€μ΄ν¬ ν‘œκΈ°λ²• μ‚¬μš©

      const SYMBOLIC_CONSTANT = 'value';
    • 클래슀 μƒμ„±μž/μƒμ„±μž ν•¨μˆ˜λŠ” λŒ€λ¬Έμž 카멜 μΌ€μ΄μŠ€ μ‚¬μš©

      // 클래슀
      class ClassName {}
      
      // μƒμ„±μž ν•¨μˆ˜
      function Person() {}
    • URL, HTML 같은 λŒ€λ¬Έμž μ•½μ–΄λŠ” κ·ΈλŒ€λ‘œ μ‚¬μš©

      const parseHTML = () => {}
      const parseXML = () => {}

  6. 이벀트 ν•Έλ“€λŸ¬λͺ…은 handle둜 μ‹œμž‘

    // Good
    const handleClick = () => {}
    
    // Bad
    const clickHandler = () => {}
    const onClick = () => {}
    const onSubmit = () => {}
    const onClickHandler = () => {}

πŸ“ 폴더 ꡬ쑰

|-- πŸ“ node_modules
|-- πŸ“ public
|-- πŸ“ src
  |-- πŸ“ apis
  |-- πŸ“ assets
  |-- πŸ“ components
  |-- πŸ“ layout
  |-- πŸ“ pages
  |-- πŸ“ routes
  |-- πŸ“ store
  |-- πŸ“ styles
|-- .env
|-- .eslintrc.cjs
|-- .gitignore
|-- .prettierrc
|-- .stylelintrc
|-- index.html
|-- package.json
|-- README.md
|-- tsconfig.json
|-- tsconfig.node.json
|-- vite.config.js
|-- yarn.lock

πŸ§‘πŸ»β€πŸ’» FE Developers πŸ‘©πŸ»β€πŸ’»


문성희

μ„œλŒ€μ›

이예림

이채원
Home View
이벀트 리슀트 쑰회 API
Benefit View
둜그인 API
νšŒμ›κ°€μž… API
λ ˆμ΄μ•„μ›ƒ κ΅¬ν˜„
Culture View
컬쳐 리슀트 쑰회 API
Card View
전체 μΉ΄λ“œ 쑰회 API
μΉ΄λ“œ 뢁마크 API
μΉ΄λ“œ 필터링 쑰회 API

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •