-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
83af822
commit b1b7cdf
Showing
2 changed files
with
114 additions
and
54 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,55 +1,60 @@ | ||
| ## 커밋 컨벤션 | ||
|
|
||
| - Feat : 새로운 기능 추가 | ||
| - Fix : 버그 수정 | ||
| - Env : 개발 환경 관련 설정 | ||
| - Style : 코드 스타일 수정 (세미 콜론, 인덴트 등의 스타일적인 부분만) ~ 코드 자체 스타일 | ||
| - Refactor : 코드 리팩토링 (더 효율적인 코드로 변경 등) | ||
| - Design : **CSS** 등 디자인 추가/수정 | ||
| - Comment : 주석 추가/수정 | ||
| - Docs : 내부 문서 추가/수정 | ||
| - Test : 테스트 추가/수정 | ||
| - Chore : 빌드 관련 코드 수정 | ||
| - Rename : 파일 및 폴더명 수정 | ||
| - Remove : 파일 삭제 | ||
|
|
||
| ## 깃 전략 | ||
|
|
||
| 2명이서 진행되는 소규모 팀이다 보니 Dev브랜치에서의 Pull과 Push를 위주로 진행 | ||
|
|
||
| - Main : 배포 브랜치 | ||
| - Dev : 작업 브랜치 | ||
|
|
||
| ## Prettier & EsLint 설정 | ||
|
|
||
| Prettier는 VSCode 사용시 저장 시 자동으로 적용, 자동으로 적용 안된다면 커밋 전 `npm run format:fix`로 해줘야합니다. | ||
| EsLint는 Airbnb 속성을 가져왔습니다. | ||
|
|
||
| - Prettier : 한줄에 최대 100자까지, 탭 사이즈는 2, 스트링 시 " 사용, Arrow 함수 사용, 세미콜론 해제 | ||
|
|
||
| ## CLI 순서 | ||
|
|
||
| ### 처음 환경 설정 시 | ||
|
|
||
| 1. git clone [github URL 주소] | ||
| 2. `npm i` | ||
| 3. `npm run dev` : 개발환경 확인 | ||
|
|
||
| ### 협업 시 | ||
|
|
||
| 1. `git pull origin dev` : 진행 사항 가져오기 | ||
| 2. `npm run format:fix` : prettier 속성에 맞춰 수정 (VSCode 사용시 생략) | ||
| 3. `git add .` && `git commit -m"[커밋컨벤션]: [커밋메세지]"` | ||
| 4. `git push origin dev` : 진행 사항 저장하기 | ||
|
|
||
| ## 배포 : CI/CD | ||
|
|
||
| ### Github Actions 사용 | ||
|
|
||
| Continuous Integration : Dev의 에러가 없을 경우 Main으로 자동 통합 | ||
|
|
||
| ### Netlify 사용 | ||
|
|
||
| Continuous Delivery : Main 브랜치 자동 배포 | ||
|
|
||
| [배포링크](https://summary-card-synchathon.netlify.app/) | ||
| # 🎃FINSET : Financial Summary Easy Tool | ||
| ## 🐶서비스 소개 | ||
|  | ||
| #### 🗄️여러가지 금융 관련 정보들을 모아서 **한 곳에 기록**해요 | ||
| #### 📒어려운 금융 정보를 GPT 기반의 생성형 AI를 이용하여 알기 쉽게 **정보를 요약**해줘요. | ||
| #### 📖요약한 금융 정보를 카드 형태로 표시하여 사용자의 **가독성을 높였어요** | ||
| #### 👨🚀새로운 카드를 사용자가 추가하여 다양한 문서들을 **손쉽게 관리**할 수 있어요 | ||
|
|
||
| - 인원 : 팀 프로젝트(FE 2 BE 2 AI 1) | ||
| - 기간 : 23.09.25 ~ 23.10.17 (3주) | ||
|
|
||
| <br/> | ||
| <div align=center> | ||
| <a href="https://summary-card-synchathon.netlify.app/" target="_blank"> | ||
| <img src="https://img.shields.io/badge/배포 링크 -5289FF?style=for-the-badge&logoColor=white" alt="example"/> | ||
| </a> | ||
| <a href="https://kdt0-choiwuhyeok--lolchampionmanagementsystem.netlify.app/" target="_blank"> | ||
| <img src="https://img.shields.io/badge/런칭 영상-FF0000?style=for-the-badge&logo=YouTube&logoColor=white" alt="example"/> | ||
| </a> | ||
| <a href="https://kdt0-choiwuhyeok--lolchampionmanagementsystem.netlify.app/" target="_blank"> | ||
| <img src="https://img.shields.io/badge/상세 서비스-000000?style=for-the-badge&logo=Notion&logoColor=white" alt="example"/> | ||
| </a> | ||
| </div> | ||
|
|
||
| ## 팀원 소개 | ||
| | 최룡준 | 최우혁 | 최인준 | 전민석 | 정민석| | ||
| |--- | --- | --- | --- | --- | | ||
| | AI, BE, 로고제작 | 기획, FE, 배포, 디자인 | 기획, FE | 디자인, BE | DB구축, BE| | ||
|
|
||
| <br> | ||
| ## 🎁기술 스택 | ||
| |아키텍처 다이어그램| | ||
| |--| | ||
| |  | | ||
|
|
||
| ## 📚기능 구현 | ||
| ### 회원가입/로그인 | ||
| .gif?id=ce3607e9-5bfb-4ea3-80a5-2f7bfb5b7aa0&table=block&spaceId=f32a4763-8f17-4080-af3f-2e4535556ea8&expirationTimestamp=1698746400000&signature=HiIlMvkQ9or8P85GNwOGJqfoT7q0QtFqntzQri-sMZU&downloadName=chrome-capture-2023-9-17+%281%29.gif) | ||
|
|
||
| ### 내 보험 정보 불러오기 | ||
|  | ||
|
|
||
| ### 카드추가 | ||
| - 제목 및 상품 설명서 pdf를 추가하고 원하는 색상을 선택한 후 추가버튼을 클릭합니다. | ||
|  | ||
| - 요약하기 까지 시간이 걸리기 때문에 비동기 처리를 통해 카드 제작 완료가 될 때 알려줍니다. | ||
|  | ||
| - 제작 완료시 알람을 울려서 카드를 확인할 수 있습니다. | ||
|  | ||
| - 자세히 보기 버튼을 클릭하면 firebase 상에 올라가 있는 pdf를 확인할 수 있습니다. | ||
|
|
||
| ### 카드 목록 분류 | ||
|  | ||
|
|
||
| ### 부동산 청약정보 불러오기 | ||
|  | ||
|
|
||
| ### 카드 정보 수정하기 | ||
|  |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| ## 커밋 컨벤션 | ||
|
|
||
| - Feat : 새로운 기능 추가 | ||
| - Fix : 버그 수정 | ||
| - Env : 개발 환경 관련 설정 | ||
| - Style : 코드 스타일 수정 (세미 콜론, 인덴트 등의 스타일적인 부분만) ~ 코드 자체 스타일 | ||
| - Refactor : 코드 리팩토링 (더 효율적인 코드로 변경 등) | ||
| - Design : **CSS** 등 디자인 추가/수정 | ||
| - Comment : 주석 추가/수정 | ||
| - Docs : 내부 문서 추가/수정 | ||
| - Test : 테스트 추가/수정 | ||
| - Chore : 빌드 관련 코드 수정 | ||
| - Rename : 파일 및 폴더명 수정 | ||
| - Remove : 파일 삭제 | ||
|
|
||
| ## 깃 전략 | ||
|
|
||
| 2명이서 진행되는 소규모 팀이다 보니 Dev브랜치에서의 Pull과 Push를 위주로 진행 | ||
|
|
||
| - Main : 배포 브랜치 | ||
| - Dev : 작업 브랜치 | ||
|
|
||
| ## Prettier & EsLint 설정 | ||
|
|
||
| Prettier는 VSCode 사용시 저장 시 자동으로 적용, 자동으로 적용 안된다면 커밋 전 `npm run format:fix`로 해줘야합니다. | ||
| EsLint는 Airbnb 속성을 가져왔습니다. | ||
|
|
||
| - Prettier : 한줄에 최대 100자까지, 탭 사이즈는 2, 스트링 시 " 사용, Arrow 함수 사용, 세미콜론 해제 | ||
|
|
||
| ## CLI 순서 | ||
|
|
||
| ### 처음 환경 설정 시 | ||
|
|
||
| 1. git clone [github URL 주소] | ||
| 2. `npm i` | ||
| 3. `npm run dev` : 개발환경 확인 | ||
|
|
||
| ### 협업 시 | ||
|
|
||
| 1. `git pull origin dev` : 진행 사항 가져오기 | ||
| 2. `npm run format:fix` : prettier 속성에 맞춰 수정 (VSCode 사용시 생략) | ||
| 3. `git add .` && `git commit -m"[커밋컨벤션]: [커밋메세지]"` | ||
| 4. `git push origin dev` : 진행 사항 저장하기 | ||
|
|
||
| ## 배포 : CI/CD | ||
|
|
||
| ### Github Actions 사용 | ||
|
|
||
| Continuous Integration : Dev의 에러가 없을 경우 Main으로 자동 통합 | ||
|
|
||
| ### Netlify 사용 | ||
|
|
||
| Continuous Delivery : Main 브랜치 자동 배포 | ||
|
|
||
| [배포링크](https://summary-card-synchathon.netlify.app/) |