diff --git a/README.md b/README.md index faea6cd..f2b7299 100644 --- a/README.md +++ b/README.md @@ -1 +1,117 @@ -The-julge +# πŸ§‘β€πŸ’Ό The Julge (더 μ€„κ²Œ) +![Frame 1913](https://github.com/user-attachments/assets/52e2d466-029e-4832-b69d-486072faeb95) + + +## πŸ§‘β€πŸ’Ό The JulgeλŠ” μ–΄λ–€ μ„œλΉ„μŠ€μΈκ°€μš”? +- The JulgeλŠ” μ‚¬μš©μžκ°€ μ›ν•˜λŠ” 쑰건의 일자리λ₯Ό κ²€μƒ‰ν•˜κ³  μ§€μ›ν•˜λ©°, 근무 μŠΉμΈκΉŒμ§€ 받을 수 μžˆλŠ” λ§€μΉ­ ν”Œλž«νΌμž…λ‹ˆλ‹€. + 고용인이 더 높은 μ‹œκΈ‰μ„ μ œκ³΅ν•  경우, μ‹œκΈ‰ 인상λ₯ μ„ κΈ°μ€€μœΌλ‘œ 일자리λ₯Ό μ •λ ¬ν•˜λŠ” λ…νŠΉν•œ κΈ°λŠ₯을 κ΅¬ν˜„ν•˜μ—¬ μ‚¬μš©μžμ—κ²Œ 더 λ‚˜μ€ 쑰건의 일자리λ₯Ό μΆ”μ²œν•©λ‹ˆλ‹€. +## πŸš€ 배포 링크 +[λ”μ€„κ²Œ λ°”λ‘œκ°€κΈ°](https://the-julge-eight.vercel.app/) + +## πŸ–οΈ νŒ€μ›μ„ μ†Œκ°œν•©λ‹ˆλ‹€ +|[![](https://avatars.githubusercontent.com/u/198836946?v=4)](https://github.com/minimo-9)|[![](https://avatars.githubusercontent.com/u/127847577?v=4)](https://github.com/Moon-ju-young)|[![](https://avatars.githubusercontent.com/u/166713026?v=4)](https://github.com/dltmdals3929)|[![](https://avatars.githubusercontent.com/u/127362044?v=4)](https://github.com/Yun-Jinwoo)| +|:---:|:---:|:---:|:---:| +| λ°•κ΄‘λ―Ό | 문주영 | 이승민 | μœ€μ§„μš° | + +## πŸ“š 기술 μŠ€νƒ + +### Language +![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white) + +### FrontEnd +![React](https://img.shields.io/badge/react-%2320232a.svg?style=for-the-badge&logo=react&logoColor=%2361DAFB) ![React Router](https://img.shields.io/badge/React_Router-CA4245?style=for-the-badge&logo=react-router&logoColor=white) ![Context-API](https://img.shields.io/badge/Context--Api-000000?style=for-the-badge&logo=react) + +### Style +![TailwindCSS](https://img.shields.io/badge/tailwindcss-%2338B2AC.svg?style=for-the-badge&logo=tailwind-css&logoColor=white) + +### 도ꡬ 및 μœ ν‹Έλ¦¬ν‹° + + +### API + + +### μ½”λ“œ 포맀터 및 검사 도ꡬ + + +### ν˜‘μ—…νˆ΄ + + +### 배포 및 CI/CD + + +## πŸ“‚ 폴더 ꡬ쑰 +``` bash +project-root/ +β”œβ”€β”€ node_modules/ +β”œβ”€β”€ public/ # 정적 νŒŒμΌλ“€μ΄ μœ„μΉ˜ν•˜λŠ” 폴더 +β”‚ └── (ν•„μš”ν•œ 정적 νŒŒμΌλ“€) +β”œβ”€β”€ src/ +β”‚ β”œβ”€β”€ api/ # API 호좜 κ΄€λ ¨ νŒŒμΌλ“€ +β”‚ β”œβ”€β”€ assets/ # ν”„λ‘œμ νŠΈμ—μ„œ μ‚¬μš©ν•˜λŠ” μžμ‚° νŒŒμΌλ“€ +β”‚ β”‚ β”œβ”€β”€ images/ +β”‚ β”‚ └── icons/ +β”‚ β”œβ”€β”€ components/ # μž¬μ‚¬μš© κ°€λŠ₯ν•œ μ»΄ν¬λ„ŒνŠΈλ“€ +β”‚ β”‚ β”œβ”€β”€ common/ # 곡용 μ»΄ν¬λ„ŒνŠΈ +β”‚ β”‚ └── layout/ # νŽ˜μ΄μ§€ λ ˆμ΄μ•„μ›ƒ μ»΄ν¬λ„ŒνŠΈλ“€ +β”‚ β”‚ └── Navbar.tsx +β”‚ β”œβ”€β”€ context/ +β”‚ β”œβ”€β”€ constants/ # μƒμˆ˜ +β”‚ β”œβ”€β”€ hooks/ # μ»€μŠ€ν…€ React ν›…λ“€ +β”‚ β”œβ”€β”€ pages/ # νŽ˜μ΄μ§€ μ»΄ν¬λ„ŒνŠΈλ“€ (λΌμš°νŠΈμ™€ 연결됨) +β”‚ β”œβ”€β”€ utils/ # μœ ν‹Έλ¦¬ν‹° ν•¨μˆ˜λ“€ +β”‚ β”œβ”€β”€ App.tsx +β”‚ β”œβ”€β”€ main.tsx +β”‚ └── index.css +β”œβ”€β”€ .prettierrc +β”œβ”€β”€ .eslintrc.cjs +β”œβ”€β”€ .gitignore +β”œβ”€β”€ index.html +β”œβ”€β”€ package.json +β”œβ”€β”€ README.md +└── vite.config.ts +``` + +## πŸ“ μ»¨λ²€μ…˜ + +### 🧐 Commit Type & Emoji Guide + +| **commit type** | **description** | +|---------------|----------------| +| feat | ✨ κΈ°λŠ₯ μΆ”κ°€ | +| feat | πŸ–ΌοΈ μ•„μ΄μ½˜ μΆ”κ°€ | +| fix | πŸ› 버그 μˆ˜μ • | +| docs | πŸ“ λ¬Έμ„œ μˆ˜μ • | +| style | 🎨 UI, μŠ€νƒ€μΌ κ΄€λ ¨ μΆ”κ°€ 및 μˆ˜μ • | +| refactor | ♻️ λ¦¬νŒ©ν† λ§ | +| chore | πŸ”§ μ„€μ •, λΉŒλ“œ λ³€κ²½ | +| chore | πŸ“ 폴더 ꡬ쑰 λ³€κ²½ λ˜λŠ” 디렉토리 μž‘μ—… | +| remove | πŸ”₯ λΆˆν•„μš”ν•œ μ½”λ“œ/파일 제거 | +| deploy | πŸš€ ν”„λ‘œμ νŠΈ 배포 | + + + +### πŸ“‚ 폴더/파일λͺ… 넀이밍 μ»¨λ²€μ…˜ + +| **λŒ€μƒ** | **κ·œμΉ™** | **μ˜ˆμ‹œ** | +| --- | --- | --- | +| 폴더λͺ… | μΌ€λ°₯μΌ€μ΄μŠ€ (kebab-case) | components, user-profile | +| μ»΄ν¬λ„ŒνŠΈ 파일λͺ… | νŒŒμŠ€μΉΌμΌ€μ΄μŠ€ (PascalCase) | UserProfile.jsx | +| 이미지/μ•„μ΄μ½˜ 파일λͺ… | μΌ€λ°₯μΌ€μ΄μŠ€ | logo-icon.png, profile-default.png | +| ν•¨μˆ˜λͺ…/λ³€μˆ˜λͺ… | μΉ΄λ©œμΌ€μ΄μŠ€ (camelCase) | fetchUserData, userList | +| ν™˜κ²½λ³€μˆ˜ | λŒ€λ¬Έμž+μŠ€λ„€μ΄ν¬μΌ€μ΄μŠ€ | VITE_API_URL | + +### πŸ–ŠοΈ Git Flow + +| **브랜치λͺ…** | **μ„€λͺ…** | +|------------|---------| +| main | 배포 브랜치 | +| develop | 톡합 개발 브랜치 | +| feature/* | κΈ°λŠ₯ 개발 브랜치 | + +### 🌿 브랜치 넀이밍 μ»¨λ²€μ…˜ + +| **브랜치 μ’…λ₯˜** | **넀이밍 κ·œμΉ™** | **μ˜ˆμ‹œ** | +| --- | --- | --- | +| κΈ°λŠ₯ 개발 | feat/{이슈번호}-{이름} | feat/13-dropdown | +| 버그 μˆ˜μ • | fix/{이슈번호}-{버그-μ„€λͺ…} | fix/24-login-button-bug | +| λ¬Έμ„œ μˆ˜μ • | docs/{이슈번호}-{λ¬Έμ„œ-μ„€λͺ…} | docs/58-readme-update |