Skip to content

AI 기반 식단 관리 서비스 웰니스코치 프론트엔드 레포지토리입니다

Notifications You must be signed in to change notification settings

wellness-coach/front-repo

Repository files navigation

💪 Wellness Coach_FE

service 생성형 AI 기반 저속노화 식단 관리 서비스, Wellness Coach 프론트엔드 레포지토리입니다.

🍅 페이지/기능 상세

  1. 로그인 페이지 login
  • 구글 로그인 구현

  1. 메인 페이지 main
  • 지난 주 평균 노화 속도계 -> 클릭 시 일별 리포트 페이지로 이동
  • 검사 진행도에 따른 UI & Flow의 변화(오늘의 식단 진단하기 => 검사페이지로 이동 / 오늘의 결과 보러가기 버튼 => 오늘 결과 페이지로 이동)
  • 저속 노화 관련 소식
  • 제품 스크랩 목록

  1. 검사 페이지 test
  • 식단 기록
  • 메뉴 추가 및 삭제
  • 임시저장 및 제출

  1. 로딩 페이지 loading

  2. 오늘 결과 페이지 resultmain testresult

  • 오늘 식단의 노화 속도계
  • AI 기반 식단 별 노화 단계 및 문제 성분 식별
  • 대체 재료 추천
  • '제품 보러가기' 클릭 시 네이버 쇼핑 페이지로 이동

  1. 일별 리포트 페이지 dailyresult dailyresult
  • 지난 리포트 모아보기

🛠 기술스택

역할 종류
Library React
Programming Language JavaScript
Styling styled-components
Data Fetching Axios
Formatting ESLint Prettier
Package Manager Yarn
Version Control Git GitHub

🤝 Convention

✍️ Code Convention

폴더 트리 구조
- 페이지 별 하나의 폴더 할당 - 같은 페이지를 이루는 파일들끼리 묶음 - 폴더 속 최상단의 컴포넌트는 속한 폴더의 이름과 같도록 한다. (ex. MainPage.jsx in MainPage folder)
📦 HACKERTHON_FE
└─ Wellness-coach_FE
   ├─ public 🦁 로고 이미지 폴더
   ├─ src 
   │  ├─ assets 🖼️ 컴포넌트에서 사용될 이미지 폴더
   │  ├─ pages 
   │  │  ├─ Login (1) 로그인 페이지
   │  │  ├─ MainPage (2) 메인페이지
   │  │  ├─ DietTest (3) 식단 진단 검사 페이지
   │  │  ├─ TestResult (4) 식단 진단 검사 결과 페이지
   │  │  └─ DailyResult (5) 일별 진단 결과 확인 페이지
   │  ├─ App.jsx 
   │  ├─ GlobalStyles.js 🖼️ 전역 스타일링 파일
   │  ├─ main.jsx
   │  ├─ reset.css  🎨 스타일링 리셋 파일
   |  └─ Router.jsx 🧭 라우터 파일
   ├─ eslintrc.cjs
   ├─ .gitignore
   ├─ index.html
   ├─ package.json
   ├─ README.md
   ├─ vite.config.js
   └─ yarn.lock
주요 규칙

네이밍 규칙

- 기본 표기법
네이밍 규칙 내용
카멜 케이스(camelCase) 폴더명, js 파일, css 파일, 변수명, 함수명
파스칼케이스(PascalCase) React 파일명, React 코드내 컴포넌트 선언(ex. )
케밥 케이스(Kebab-case) 태그의 클래스 or 아이디명

  • 컴포넌트 파일 작성: 함수 선언식으로 작성 (ex. function Component)
  • 내부 함수: 화살표 함수
  • Styled-Components 네이밍 두 개 이상의 개체를 포함하고 있는 개체 = container 하나의 개체를 포함하고 있는 개체 = wrapper
  • button은 btn으로 축약 (ex. LoginButton -> LoginBtn)
  • 함수 네이밍: camelCase (ex. addDietTip)
  • handler함수명: handle~ (ex. handleDelete)
  • 단위: border, border-radius는 px 사용, 나머지 property는 rem 사용
  • let 사용 지양

🫙 Git Convention

commit 규칙
태그 내용
add 새로운 기능 or 컴포넌트를 추가
design CSS 코드 수정
fix 버그 수정
Docs 문서 수정
Chore 패키지 매니저 수정, 패키지 관리자 구성 등 Production Code 이외의 변경
Remove 파일 수정

"태그: 커밋 내용"의 형식으로 작성해주세요!
ex) add: 로그인 컴포넌트 추가, Chore: eslint extension 수정

PR 규칙

PR 주의사항

- 최대한 자세하게 내용을 기재해주세요
- 작업한 파일 이외의 파일에 수정을 했는지 확인하고 PR 날려주세요
이시온 공윤호
이시온 공윤호
FE FE
xionng Patrick-Gong

About

AI 기반 식단 관리 서비스 웰니스코치 프론트엔드 레포지토리입니다

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published