diff --git a/README.md b/README.md index 0d6babe..af9a60a 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,128 @@ -# React + TypeScript + Vite +## ✨ 프로젝트 소개 -This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules. +DDang은 반려견 산책 서비스입니다. 산책 시 200미터 안에 산책하는 또다른 사용자가 있다면 해당 사용자에게 강번따 요청을 할 수 있습니다. 승낙 시 서로의 위치를 공유하며 만나서 함께 산책할 수 있는 서비스를 제공하며, 함께 산책을 마치면 친구를 맺을 수도 있습니다. +- 배포 URL : https://ddang.pages.dev/ -Currently, two official plugins are available: +## 👪 팀원 구성 -- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh -- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh +### **프론트엔드** -## Expanding the ESLint configuration +||||| +|:-:|:-:|:-:|:-:| +|Seonghoon Lee
[@shlee9999](https://github.com/shlee9999)|Kim Ju Young
[@kimjuyoung99](https://github.com/kimjuyoung99)|wonil
[@wonill](https://github.com/wonill)|한규
[@ruehan](https://github.com/ruehan)| -If you are developing a production application, we recommend updating the configuration to enable type aware lint rules: -- Configure the top-level `parserOptions` property like this: +### **백엔드** +||||| +|:-:|:-:|:-:|:-:| +|MoonJaeGyeong
[@MoonJaeGyeong](https://github.com/MoonJaeGyeong)|YesGwanTae
[@Repaion24](https://github.com/Repaion24)|KyungHun Song
[@rudgns328](https://github.com/rudgns328)|[@highjjjw](https://github.com/highjjjw)| -```js -export default { - // other rules... - parserOptions: { - ecmaVersion: 'latest', - sourceType: 'module', - project: ['./tsconfig.json', './tsconfig.node.json'], - tsconfigRootDir: __dirname, - }, -} +## **📅 개발 기간 및 작업 관리** + +### **⏰ 개발 기간** + +- 2024.11.15 ~ 2024.12.09 + +### **📊 작업 관리** + +- 프로젝트 기간이 짧았던 만큼, 매주 월요일마다 스프린트 하였습니다. +- 데일리 스크럼을 통해 팀원 간 작업 상황을 공유하였습니다. +- [Github Project](https://github.com/orgs/prgrms-web-devcourse-final-project/projects/4)에서 Stroy Point를 이용해 작업을 관리하였습니다. + + +## ♻️ 개발 환경 + +- Front : Vite React Typescript +- Back : Java Spring +- Version & Issue Management : Github Project +- Tools : Discord, Slack, Notion +- Service : Cloudflare +- Design : Figma + +## 📃 커밋 컨벤션 + +| Type | Description | +| --- | --- | +| ✨`Feat` | 새로운 기능 추가 | +| 🐛`Fix` | 버그 수정 | +| 📝`Docs` | 문서 수정, 주석 관련 | +| ♻️`Refactor` | 코드 리펙토링 | +| ✅`Test` | 테스트 코드, 리펙토링 테스트 코드 추가 | +| 🔧`Chore` | 빌드 업무 수정, 패키지 매니저 수정 (package.json 수정) | +| 🎨`Design` | CSS | +| 🔥`Remove` | 파일 제거 | +| 🚚`Rename` | 파일 혹은 폴더명 수정 | +| 🔨`Setting` | 개발 환경 셋팅 관련 | +| 🚀`Perf` | 성능 최적화 관련 | +| 🚨`Hotfix` | 핫픽스 | + + +## **🏗️ 프로젝트 구조** + + +```jsx +📦src + ┣ 📂apis + ┣ ... + ┃ ┗ 📜axiosInstance.ts + ┣ 📂assets + ┣ 📂components + ┃ ┣ 📂Button + ┃ ┣ 📂DogProfile + ┃ ┣ 📂Header + ┃ ┣ 📂Input + ┃ ┣ 📂PushNotification + ┃ ┣ ... + ┣ 📂constants + ┣ 📂data + ┣ 📂hooks + ┃ ┣ 📜useClearModal.ts + ┃ ┣ 📜useGeolocation.ts + ┃ ┣ 📜useScrollPreservation.ts + ┃ ┣ ... + ┣ 📂modals + ┣ 📂pages + ┣ 📂stores + ┣ 📂styles + ┣ 📂types + ┣ 📂utils + ┣ 📂stores + ┣ 📂styles + ┣ 📂types + ┣ 📂utils ``` + + +## 📄 담당 페이지 + +### 김주영(PM) + +**패밀리댕** + + + +### 한 규 + +**산책** + + +https://github.com/user-attachments/assets/3ac31188-4c20-490e-88f9-c43cf4b5c81a + + +### 이성훈 + +**홈페이지**                                                            **프로필 페이지** + + + +**소셜 페이지**                                                         **채팅** + + + + +### 남원일 + + + + -- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked` -- Optionally add `plugin:@typescript-eslint/stylistic-type-checked` -- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list