논의한 사항
리드미에 무엇이 들어가야 하는가?
- 로고, 배포주소 프로젝트 소개 팀원 소개 기술 스택
- 중간때 node랑 Npm 버전 써야한다고 피드백받았었습니다
- 실행 방법
README
- 로고
- 프론트 배포 주소
- 프로젝트 소개 (간단하게)
책모이
는 온라인 상에서 책 스터디를 더 쉽고 편하게 운영하고 진행 할 수 있도록 도와주는 웹 서비스 입니- 사용자는 원하는 책을 검색해서 스터디를 등록 할 수 있습니다
- 원하는 책을 선택해서 해당 책을 대상으로 개설된 스터디에 참여 할 수 있습니다.
- 스터디내의 게시판을 통해서 스터디원들과 책 내용을 나눌수 있습니다.
- 게시판에서 댓글을 통해서 스티디원들과 다양한 소통이 가능합니다
- 실행방법
- env 설명
- 프로젝트를 실행시키려면 다음과 같은 환경변수가 필요합니다.
NEXT_PUBLIC_X_NAVER_CLIENT_ID NEXT_PUBLIC_X_NAVER_CLIENT_SECRET NEXT_PUBLIC_KAKAO_API NEXT_PUBLIC_API_END_POINT
yarn install yarn dev
- 개발 환경 / 기술 스택
- yarn: 1.22이상..?, node version : v16.14.2 이상
- React : 18.2.0, Next.js : 12.2.3
- mui context api, storybook
- emotion
- eslint / prettier
- 폴더 구조 / 디자인 패턴
- component별로 component, style을 작성하고 index에서 import/export
``` Team-Books-CheckMoi-FE ├─ apis ├─ components │ ├─ BookCard │ ├─ BookCard.stories.tsx │ ├─ BookCard.tsx │ ├─ BookCardSkeleton.tsx │ ├─ index.ts │ └─ style.tsx ├─ contexts ├─ features ├─ hooks ├─ next-env.d.ts ├─ next.config.js ├─ package.json ├─ pages ├─ public ├─ README.md ├─ styles ├─ tsconfig.json ├─ types ├─ utils ```
- 팀원 소개
- Retto(팀장) - 무한스크롤, 책 상세, 스터디 소개
- Feel - 홈, 검색, 탑바, 전역 Context
- Buzz - 공통 API 설계, 스터디 생성, 수정
- Min - 포스트 목록, 댓글, 스터디 상세
- Lina - 유저 프로필, 포스트