Skip to content

Commit

Permalink
fix: add meta tag, og and README.md (#40)
Browse files Browse the repository at this point in the history
* chore: build test

* feat: 약관 및 정책 추가

* feat: 메타 태그 추가

* docs: create README.md
  • Loading branch information
a-honey authored Mar 1, 2024
1 parent 6370504 commit 777345a
Show file tree
Hide file tree
Showing 4 changed files with 85 additions and 3 deletions.
66 changes: 66 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1 +1,67 @@
# Fridge Link - FE
> DDD 10기 WEB 1팀 MARA 웹 프론트엔드 레포지토리
Fridge Link는 냉장고 속 식자재를 관리하고, 식자재를 지인들과 나눔하는 냉장고 관리 서비스입니다. 소비기한이 지나 버려지는 식자재를 관리하기 위해 간단한 추가 과정, 식자재 소비기한 알림, 지인들과의 냉장고 공유 및 나눌 수 있는 서비스를 제공합니다.

🔗 서비스 링크 : https://fridgelink.site

![image](https://github.com/DDD-Community/fridge-link-web/assets/75254185/3bf331be-ccb4-4a98-8202-b72910c56d44)


## 주요 기능 및 특징
### 🩷 회원가입
카카오/구글을 활용한 소셜 로그인을 통해 간편하게 회원가입하여 닉네임과 4가지 버전의 프로필 이미지를 설정합니다.

### 💚 내 냉장고 식자재 추가
사용자는 냉장고에 식자재를 냉장/냉동을 구분하여 추가할 수 있으며 식자재 추가 시 이름/소비기한/수량/메모 등을 설정합니다.
홈 페이지에서 소비기한이 얼마 남지 않은 식자재를 사용자에게 알려줍니다.

### 💛 친구 추가 및 친구 냉장고 최신 근황 공유
사용자 고유의 초대 코드를 활용하여 손쉽게 친구 추가할 수 있으며, 친구의 최신 근황 및 친구 냉장고를 살펴볼 수 있습니다.

### 💜 나눔
나눔을 통해 버려지는 식자재가 줄어들 수 있도록 냉장고 속 식자재를 친구들에게 나눔합니다.
사용자가 나눔하는 과정에서 혼란스럽지 않도록 나눔글 상태 나눔 신청, 나눔 중, 나눔 완료로 세분화하였습니다.

## Information Architecture
![image](https://github.com/DDD-Community/fridge-link-web/assets/75254185/e543be57-25fe-4d86-9548-a9fc77acd79a)

## Period
- 2023.11.25 ~ 2024.03.02

## Stacks
![Next.js](https://img.shields.io/badge/-Next.js-000000?style=for-the-badge&logo=next.js&logoColor=ffffff)
![React Native](https://img.shields.io/badge/React%20Native-61DAFB?style=for-the-badge&logo=react&logoColor=ffffff)
![TypeScript](https://img.shields.io/badge/-TypeScript-3178C6?style=for-the-badge&logo=typescript&logoColor=ffffff)
![Tanstack Query](https://img.shields.io/badge/tanstack--query-2D3748?style=for-the-badge)
![Axios](https://img.shields.io/badge/Axios-007ACC?style=for-the-badge&logo=axios&logoColor=ffffff)
![Recoil](https://img.shields.io/badge/Recoil-764ABC?style=for-the-badge)
![React Hook Form](https://img.shields.io/badge/React%20Hook%20Form-0D67F2?style=for-the-badge&logo=react&logoColor=ffffff)
![Tailwind CSS](https://img.shields.io/badge/Tailwind%20CSS-38B2AC?style=for-the-badge&logo=tailwind-css&logoColor=ffffff)
![Swiper](https://img.shields.io/badge/Swiper-6332F6?style=for-the-badge&logo=swiper&logoColor=ffffff)
![Storybook](https://img.shields.io/badge/Storybook-FF4785?style=for-the-badge&logo=storybook&logoColor=ffffff)
![Husky](https://img.shields.io/badge/Husky-4E8EE9?style=for-the-badge&logo=husky&logoColor=ffffff)
![AWS](https://img.shields.io/badge/AWS-232F3E?style=for-the-badge&logo=amazon-aws&logoColor=ffffff)

## Convetion
### 🌸 Merge & Branch
- 최소 1명의 approve 통과
- husky 및 build ci 통과
- squash merge
- 브랜치명 Jira 티켓 번호 사용
- rebase
### 🌈 Commit
- feat: 새로운 기능 추가, 마크업
- fix: 에러 수정
- style: 코드 스타일 수정
- docs: 문서 작성 및 편집
- refactor: 코드 리팩토링
- chore: 기타 작업

## Developers
| 한혜선 | 정아현 |
| :----: | :----: |
| <img src="https://avatars.githubusercontent.com/hyeseon-han" alt="profile" width="180" height="180"> | <img src="https://avatars.githubusercontent.com/a-honey" alt="profile" width="180" height="180"> |
| [@hyeseon-han](https://github.com/hyeseon-han) | [@a-honey](https://github.com/a-honey) |

Received some code review from [@choipureum](https://github.com/choipureum)👩‍💻🚀
Binary file modified public/favicon.ico
Binary file not shown.
16 changes: 14 additions & 2 deletions src/pages/_document.tsx
Original file line number Diff line number Diff line change
@@ -1,9 +1,21 @@
import { Html, Head, Main, NextScript } from 'next/document';
import { Head, Html, Main, NextScript } from 'next/document';

export default function Document(): JSX.Element {
return (
<Html lang="en">
<Head />
<Head>
<title>Fridge Link</title>
<meta name="author" content="DDD 10th WEB 1 team" />
<meta name="description" content="식자재를 관리하고, 지인들과 나눔하는, 냉장고 관리 서비스" />
<meta property="og:title" content="Fridge Link" />
<meta
property="og:description"
content="냉장고 속 식자재를 관리하고, 식자재를 지인들과 나눔하는 냉장고 관리 서비스"
/>
<meta property="og:image" content="https://fridgelink.site/favicon.ico" />
<meta property="og:url" content="https://fridgelink.site" />
<meta property="og:type" content="website" />
</Head>
<body>
<Main />
<NextScript />
Expand Down
6 changes: 5 additions & 1 deletion src/pages/mypage/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,11 @@ const GENERAGE_NAV_LIST = [

const ETC_NAV_LIST = [
{ name: '문의', svgComponent: <QuestionIcon />, linkTo: 'https://forms.gle/m9NtmA2ppgzr9h24A' },
{ name: '약관 및 정책', svgComponent: <PolicyIcon />, linkTo: '#' },
{
name: '약관 및 정책',
svgComponent: <PolicyIcon />,
linkTo: 'https://italsehf.notion.site/8e408542be134c4781f9cf8ccc3a17ec?pvs=74',
},
{ name: '버전정보', svgComponent: <InfoIcon />, linkTo: '', text: '1.0.1' },
];

Expand Down

0 comments on commit 777345a

Please sign in to comment.