diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index b7ba055..acdb1bc 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -1,10 +1,11 @@ name: Tests on: - push: - branches: [main, develop] pull_request: branches: [main, develop] + paths-ignore: + - "README.md" + - "docs/**" jobs: unit-tests: diff --git a/README.md b/README.md index 40e8d3a..2ad904a 100644 --- a/README.md +++ b/README.md @@ -6,34 +6,32 @@ ## πŸ“‹ ν”„λ‘œμ νŠΈ μ†Œκ°œ -κ°œλ°œμ„ 혼자 κ³΅λΆ€ν•˜κΈ° μ–΄λ €μš°μ‹ κ°€μš”? ν•¨κ»˜ν•  νŒ€μ›μ„ μ°Ύκ³  κ³„μ‹ κ°€μš”? -WeCodeμ—μ„œ 같은 λͺ©ν‘œλ₯Ό κ°€μ§„ κ°œλ°œμžλ“€κ³Ό μ—°κ²°λ˜μ–΄ ν•¨κ»˜ μ„±μž₯ν•΄λ³΄μ„Έμš”! - -### μ£Όμš” νŠΉμ§• - -WeCodeλŠ” **νŒ€μ› λͺ¨μ§‘ κΈ€ μž‘μ„±**뿐만 μ•„λ‹ˆλΌ **ν”„λ‘œν•„ 등둝**을 톡해 νŒ€ λΉŒλ”© μ œμ•ˆμ„ 받을 수 μžˆλŠ” μ–‘λ°©ν–₯ λ§€μΉ­ ν”Œλž«νΌμž…λ‹ˆλ‹€. +개발자, λ””μžμ΄λ„ˆ, 기획자 λ“± λ‹€μ–‘ν•œ μ§κ΅°μ—μ„œ μ‚¬μš©μžκ°€ νŒ€μ„ λͺ¨μ§‘ν•˜κ±°λ‚˜ νŒ€λΉŒλ”© μ œμ•ˆμ„ 받을 수 μžˆλŠ” μ–‘λ°©ν–₯ νŒ€ λ§€μΉ­ ν”Œλž«νΌμž…λ‹ˆλ‹€. λͺ¨μ§‘ κΈ€ μž‘μ„±λΏ μ•„λ‹ˆλΌ λ‚΄ ν”„λ‘œν•„ 등둝을 톡해 μ œμ•ˆμ„ 주고받을 수 μžˆμ–΄, 단방ν–₯ μ„œλΉ„μŠ€μ™€ 달리 μ‚¬μš©μžκ°€ λŠ₯λ™μ μœΌλ‘œ νŒ€ λΉŒλ”© 과정에 μ°Έμ—¬ν•˜κ³ , μžμ‹ μ—κ²Œ λ§žλŠ” ν˜‘μ—… 기회λ₯Ό λ°œκ²¬ν•  수 있게 λ„μ™€μ€λ‹ˆλ‹€. ## ✨ μ£Όμš” κΈ°λŠ₯ ### 🏠 메인 νŽ˜μ΄μ§€ -- **μΉ΄ν…Œκ³ λ¦¬λ³„ κ²Œμ‹œκΈ€ 쑰회** : 졜근 ν”„λ‘œμ νŠΈ/μŠ€ν„°λ”” λͺ¨μ§‘κΈ€ 및 등둝 ν”„λ‘œν•„ 쑰회 +- **졜근 ν”„λ‘œμ νŠΈ/μŠ€ν„°λ”” λͺ¨μ§‘κΈ€ 및 등둝 ν”„λ‘œν•„ 쑰회** -### πŸ“ κ²Œμ‹œκΈ€ +### πŸ“ κ²Œμ‹œκΈ€ μž‘μ„± -- **ν…μŠ€νŠΈ 에디터** : BlockNote 기반 ν…μŠ€νŠΈ νŽΈμ§‘ -- **μž„μ‹œμ €μž₯ κΈ°λŠ₯** : μž‘μ„± 쀑인 글을 μž„μ‹œλ‘œ μ €μž₯ν•˜κ³  μ΄μ–΄μ„œ μž‘μ„± -- **상세 정보 μž…λ ₯** - - λͺ¨μ§‘ 인원, μ§„ν–‰ κΈ°κ°„, λͺ¨μ§‘ 마감일 - - μ§„ν–‰ 방식 (온라인/μ˜€ν”„λΌμΈ) +- **κ²Œμ‹œκΈ€ μž‘μ„±** + - ν…μŠ€νŠΈ 에디터 + - μž„μ‹œμ €μž₯ κΈ°λŠ₯ + - 상세 정보 μž…λ ₯ +- **κ²Œμ‹œκΈ€ 상세 쑰회** +- **κ²Œμ‹œκΈ€ μˆ˜μ •** +- **κ²Œμ‹œκΈ€ μ‚­μ œ** -### πŸ‘₯ λ™λ£Œ μ°ΎκΈ° +### πŸ‘₯ λ™λ£Œ μ°ΎκΈ° νŽ˜μ΄μ§€ -- **개발자 ν”„λ‘œν•„ 등둝** +- **ν”„λ‘œν•„ 등둝** - 직무, ν¬μ§€μ…˜, κ²½λ ₯ 정보 - ν™œλ™ μ§€μ—­, μžκΈ°μ†Œκ°œ - μ™ΈλΆ€ 링크 -- **ν”„λ‘œν•„ 및 필터링** : μ›ν•˜λŠ” 쑰건의 λ™λ£Œ μ°ΎκΈ° +- **ν”„λ‘œν•„ μˆ˜μ •** +- **ν”„λ‘œν•„ 쑰회 및 필터링** : μ›ν•˜λŠ” 쑰건의 λ™λ£Œ μ°ΎκΈ°
@@ -59,20 +57,21 @@ WeCodeλŠ” **νŒ€μ› λͺ¨μ§‘ κΈ€ μž‘μ„±**뿐만 μ•„λ‹ˆλΌ **ν”„λ‘œν•„ 등둝**을 ``` src/ +β”œβ”€β”€ api/ # API 호좜 ν•¨μˆ˜ +β”œβ”€β”€ assets/ # 이미지, GIF λ“± β”œβ”€β”€ components/ # μž¬μ‚¬μš© κ°€λŠ₯ν•œ μ»΄ν¬λ„ŒνŠΈ -β”‚ β”œβ”€β”€ common/ # 곡톡 μ»΄ν¬λ„ŒνŠΈ (Header, Footer λ“±) -β”‚ β”œβ”€β”€ recruits/ # λ™λ£Œ μ°ΎκΈ° κ΄€λ ¨ μ»΄ν¬λ„ŒνŠΈ -β”‚ β”œβ”€β”€ write/ # κΈ€μ“°κΈ° κ΄€λ ¨ μ»΄ν¬λ„ŒνŠΈ (Editor, FileUpload λ“±) +β”‚ β”œβ”€β”€ common/ # 곡톡 μ»΄ν¬λ„ŒνŠΈ β”‚ β”œβ”€β”€ ui/ # Shadcn/ui 기반 UI μ»΄ν¬λ„ŒνŠΈ -β”‚ └── constants/ # μƒμˆ˜ μ •μ˜ (μΉ΄ν…Œκ³ λ¦¬, μ˜΅μ…˜ λ“±) +β”‚ └── constants/ # μƒμˆ˜ μ •μ˜ β”œβ”€β”€ pages/ # νŽ˜μ΄μ§€ μ»΄ν¬λ„ŒνŠΈ -β”‚ β”œβ”€β”€ auth/ # 인증 κ΄€λ ¨ νŽ˜μ΄μ§€ (OAuth 콜백) -β”‚ β”œβ”€β”€ find-teammates/ # νŒ€μ› μ°ΎκΈ° νŽ˜μ΄μ§€ -β”‚ β”œβ”€β”€ post/ # κ²Œμ‹œκΈ€ κ΄€λ ¨ νŽ˜μ΄μ§€ (μž‘μ„±, 상세) -β”‚ β”œβ”€β”€ recruit/ # λͺ¨μ§‘ νŽ˜μ΄μ§€ -β”‚ └── sign-in/ # 둜그인/νšŒμ›κ°€μž… νŽ˜μ΄μ§€ -β”œβ”€β”€ hooks/ # μ»€μŠ€ν…€ ν›… (인증) -β”œβ”€β”€ lib/ # Supabase, SWR λ“± μœ ν‹Έλ¦¬ν‹° +β”‚ β”œβ”€β”€ auth/ # 인증 κ΄€λ ¨ νŽ˜μ΄μ§€ (OAuth 콜백) +β”‚ β”œβ”€β”€ find-teammates/ # λ™λ£Œ μ°ΎκΈ° νŽ˜μ΄μ§€ +β”‚ β”œβ”€β”€ post/ # κ²Œμ‹œκΈ€ κ΄€λ ¨ νŽ˜μ΄μ§€ (μž‘μ„±, 상세, μˆ˜μ •) +β”‚ β”œβ”€β”€ recruit/ # νŒ€μ› λͺ¨μ§‘ νŽ˜μ΄μ§€ +β”‚ β”œβ”€β”€ sign-in/ # 둜그인 νŽ˜μ΄μ§€ +β”‚ └── sign-up/ # νšŒμ›κ°€μž… νŽ˜μ΄μ§€ +β”œβ”€β”€ hooks/ # μ»€μŠ€ν…€ ν›… +β”œβ”€β”€ lib/ # Supabase, TanStack Query λ“± μœ ν‹Έλ¦¬ν‹° β”œβ”€β”€ stores/ # Zustand μƒνƒœ 관리 └── types/ # TypeScript νƒ€μž… μ •μ˜ ``` @@ -84,7 +83,6 @@ src/ - **React** - **TypeScript** - **Vite** -- **React Router** ### Styling & UI @@ -94,13 +92,23 @@ src/ ### State Management & Forms - **Zustand** +- **TanStack Query** - **React Hook Form** - **Zod** +### Testing + +- **Vitest** +- **Cypress** + ### Backend & Database - **Supabase** +### Deployment + +- **Vercel** + ### Text Editor - **BlockNote** diff --git a/src/assets/preview2.gif b/src/assets/preview2.gif index faf8754..68cd984 100644 Binary files a/src/assets/preview2.gif and b/src/assets/preview2.gif differ diff --git a/src/assets/preview4.gif b/src/assets/preview4.gif index d182726..74763fe 100644 Binary files a/src/assets/preview4.gif and b/src/assets/preview4.gif differ