Skip to content

NOW-SOPT-CDSP-TEAM-WEB4/Notefolio-Client

Repository files navigation

λ…ΈνŠΈν΄λ¦¬μ˜€


image

πŸ“Œ 합동 μ„Έλ―Έλ‚˜ - λ…ΈνŠΈν΄λ¦¬μ˜€

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

✨ OUR TEAM

ν”„λ‘œν•„μ‚¬μ§„ ν”„λ‘œν•„μ‚¬μ§„ ν”„λ‘œν•„μ‚¬μ§„
μ •μš°
건휘
신지
@jungwoo3490 @KIMGEONHWI @sinji2102

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

μ—­ν•  μ’…λ₯˜
Library React
Programming Language TypeScript
Styling Styled Components
Data Fetching Axios
Formatting ESLint Prettier StyleLint
Package Manager Yarn
Version Control Git GitHub
Deployment Vercel

🌳 κ΅¬ν˜„ View

🌿 Home View

homepage_1 homepage_2

🌿 Community View

cardpage_1 cardpage_2

🌿 Recruit View

benefitpage_1 benefitpage_2

🌿 Search View

culturepage_1 homepage_2

πŸ‘₯ μ—­ν•  λΆ„λ‹΄

πŸ‘¨πŸ»β€πŸ’» μ •μš°

μ’…λ₯˜ λͺ©λ‘
setting βš™οΈ husky & lint-staged 폴더 ꡬ쑰 λΌμš°νŒ…
view πŸ“± 곡톡 μ»΄ν¬λ„ŒνŠΈ(Chip 리슀트) Recruit νŽ˜μ΄μ§€ Search νŽ˜μ΄μ§€
api πŸ“‘ ν¬λ¦¬μ—μ΄ν‹°λΈŒ 검색 (GET)

πŸ‘¨πŸ»β€πŸ’» 건휘

μ’…λ₯˜ λͺ©λ‘
setting βš™οΈ GlobalStyle VITE svg eslint & prettier
view πŸ“± 곡톡 μ»΄ν¬λ„ŒνŠΈ(상단 Header) Home νŽ˜μ΄μ§€
api πŸ“‘ ν¬λ¦¬μ—μ΄ν‹°λΈŒ 쑰회 (GET) ν¬λ¦¬μ—μ΄ν‹°λΈŒ μ’‹μ•„μš” (POST) ν¬λ¦¬μ—μ΄ν‹°λΈŒ μ’‹μ•„μš” μ·¨μ†Œ (DELETE)

πŸ‘©πŸ»β€πŸ’» 신지

μ’…λ₯˜ λͺ©λ‘
setting βš™οΈ stylelint theme
view πŸ“± 곡톡 μ»΄ν¬λ„ŒνŠΈ(Sticky Navigation λ°”) Community νŽ˜μ΄μ§€
api πŸ“‘ μ›Œν¬μƒ΅ 전체 쑰회(GET) ν”„λ‘œκ·Έλž¨ 전체 쑰회 (GET)
1️⃣ Commit μ»¨λ²€μ…˜

commit κ·œμΉ™

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

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

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

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

브랜치 μ „λž΅

νŽ˜μ΄μ§€λͺ…/#이슈번호-κΈ°λŠ₯λͺ…

Git Branch

  • 브랜치 운영
    • main: μ™„μ „νžˆ μ•ˆμ „ν•˜λ‹€κ³  νŒλ‹¨λ˜μ—ˆμ„ λ•Œ, 즉 배포가 κ°€λŠ₯ν•œ μ΅œμ’… mergeν•˜λŠ” 브랜치
    • develop: λ°°ν¬ν•˜κΈ° μ „ 개발 쀑일 λ•Œ 각자의 λΈŒλžœμΉ˜μ—μ„œ mergeν•˜λŠ” 브랜치 (default 브랜치)
    • feature/νŽ˜μ΄μ§€λͺ…: 각 νŽ˜μ΄μ§€λ³„ κΈ°λŠ₯ 개발 브랜치, 개발이 μ™„λ£Œλ˜λ©΄ develop 브랜치둜 병합
    • νŽ˜μ΄μ§€λͺ…/#이슈번호-κΈ°λŠ₯λͺ…: feature 브랜치. μƒˆλ‘œμš΄ κΈ°λŠ₯ 개발. 개발이 μ™„λ£Œλ˜λ©΄ feature/νŽ˜μ΄μ§€λͺ… 브랜치둜 병합
3️⃣ μ½”λ”© μ»¨λ²€μ…˜
  1. μƒμˆ˜λŠ” 영문 λŒ€λ¬Έμž μŠ€λ„€μ΄ν¬ ν‘œκΈ°λ²• (예λ₯Ό λ“€λ©΄ ν‚€κ°’)
  2. ν΄λž˜μŠ€λ‚˜ μ»΄ν¬λ„ŒνŠΈλŠ” λŒ€λ¬Έμž 파슀칼 μΌ€μ΄μŠ€ μ‚¬μš© (ν•¨μˆ˜ν˜• μ»΄ν¬λ„ŒνŠΈ)
  3. μ»΄ν¬λ„ŒνŠΈλŠ” rfce, λ‚˜λ¨Έμ§€ ν•¨μˆ˜λŠ” ν™”μ‚΄ν‘œ ν•¨μˆ˜ 이용
  4. μ•”μ‹œμ  λ°˜ν™˜μ„ μ΅œλŒ€ν•œ ν™œμš© (early return)
  5. axios μ“Έ λ•Œ then & catch, async await μ“Έ λ•Œ try & catch μ‚¬μš©
  6. ꡬ쑰뢄해할당 적극 이용
  // ꡬ쑰뢄해 μ‚¬μš© X
  const SearchBar = (props) => {
    const { a, b, c } = props;
    ...
    
  // ꡬ쑰뢄해 μ‚¬μš© O
  const SearchBar = ({ a, b, c }) => {
    ...
  1. ꡬ쑰뢄해할당 적극 이용
  2. λ³€μˆ˜ 등을 μ‘°ν•©ν•΄μ„œ λ¬Έμžμ—΄μ„ 생성할 λ•ŒλŠ” λ°˜λ“œμ‹œ λ¦¬ν„°λŸ΄μ„ 이용
  3. switch-case μ‚¬μš©μ‹œ break κ°•μ œ
  4. 쑰건문은 λ°˜λ“œμ‹œ μ‚Όν•­ μ—°μ‚°μž μ‚¬μš©
  5. forλŠ” μ§€μ–‘ν•˜κ³  forEach, map을 μ‚¬μš©
  6. 주석은 μž‘μ„±ν•˜λ €κ³  ν•˜λŠ” λŒ€μƒ λ°”λ‘œ μœ„μ— μž‘μ„±
  7. button νƒœκ·Έμ—λŠ” type을 λͺ…μ‹œ
  8. λ²„νŠΌ, 헀더와 같이 common componentμ—μ„œλŠ” children 적극 ν™œμš©
  9. styleds-components λŠ” tsx 맨 μ•„λž˜μ— μ„ μ–Έ
  10. μ»΄ν¬λ„ŒνŠΈ μ΅œμƒλ‹¨μ— κ°μ‹ΈλŠ” 것은 {μ»΄ν¬λ„ŒνŠΈλͺ…}Wrapper
  11. μ»΄ν¬λ„ŒνŠΈ μ„ μ–Έκ³Ό 처음 styled-components μ„ μ–Έ 사이 ν•œμ€„ 띄어쓰기
  12. μ»΄ν¬λ„ŒνŠΈμ—μ„œ props둜 전달받은 interfaceλ₯Ό 선언해쀄 λ•Œ, μ»΄ν¬λ„ŒνŠΈλͺ… + Props둜 μ„ μ–Έ

πŸ“ 폴더 ꡬ쑰

|-- πŸ“ .github
|-- πŸ“ .husky
|-- πŸ“ node_modules
|-- πŸ“ public
|-- πŸ“ src
  |-- πŸ“ apis
  |-- πŸ“ assets
  |-- πŸ“ components
  |-- πŸ“ constants
  |-- πŸ“ hooks
  |-- πŸ“ libs
  |-- πŸ“ pages
  |-- πŸ“ styles
  |-- πŸ“ types
  |-- πŸ“ utils
  |-- πŸ“ Router.tsx
|-- .env
|-- .eslintignore
|-- .eslintrc.json
|-- .gitignore
|-- .prettierignore
|-- .prettierrc
|-- .stylelintrc.json
|-- index.html
|-- package.json
|-- svg.d.ts
|-- README.md
|-- tsconfig.json
|-- tsconfig.node.json
|-- vite.config.ts
|-- yarn.lock

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages