Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: 리드미 추가 #361

Merged
merged 1 commit into from
Oct 30, 2024
Merged

docs: 리드미 추가 #361

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 44 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,23 +9,57 @@
다음 명령어를 입력하면 프로젝트 설치 후 실행됩니다.

```bash
git clone https://github.com/prgrms-fe-devcourse/FEDC4_TMI_HOMERS_OFF.git && cd FEDC4_TMI_HOMERS_OFF
npm install
git clone https://github.com/prgrms-fe-devcourse/FEDC4_TMI_HOMERS_OFF.git
cd FEDC4_TMI_HOMERS_OFF
npm ci
npm run dev
```

## 프로젝트 소개

> **TMI HOMERS** 는 'TMI (Too Much Information)'와 'HOMERS (전서구)'를 결합한 독특한 소셜 네트워크 플랫폼으로, 사용자들이 흥미로운 이야기와 정보를 자유롭게 공유하고 즐길 수 있는 공간을 제공합니다. [발표 자료](https://docs.google.com/presentation/d/1ad7gy4-F7XuWfotjmdqsUmEuv5nuP0WS0aBQGHLYXOM/edit#slide=id.g2848580536a_5_0) [발표 영상](https://drive.google.com/drive/u/0/my-drive)

## ✨ 기획 배경

**TMI HOMERS**는 자신의 TMI를 기록하고 공유할 수 있는 독특한 커뮤니티 사이트입니다.

사용자들은 글을 작성할 때 익명성을 지키기 위해 **`'기자'`🎤**라는 역할을 맡게 되며, 자신의 소소한 경험을 `'뉴스기사'`📝 형식으로 기록합니다. 이로써 사용자들은 부담 없이 자신의 이야기를 공유할 수 있습니다.

뿐만 아니라, **TMI HOMERS**는 타인의 TMI를 유쾌하게 즐기고 공유함으로써, 일상에서 재미와 유쾌함을 찾는 데 기여합니다. 이런 방식으로 마치 `'말랑한 사회'`라고 할 수 있는 따뜻하고 유쾌한 분위기를 조성합니다.

## 핵심기능

- 사용자들은 자신의 흥미로운 이야기와 정보, 즉 TMI를 모든 사람들에게 자유롭게 공유할 수 있습니다.
- 사용자들은 다른 사람들이 공유한 TMI 목록을 탐색하고 볼 수 있습니다.
- 사용자들은 해당 TMI에 댓글을 작성할 수 있습니다.

## 주요 타겟층

- 자신의 TMI를 추억하고 기록으로 남기고 싶은 사람
- 작고 소소한 일상에도 즐거움과 의미를 찾는 사람
- 다른 사람의 TMI를 찾아보고 공유하고 싶은 사람

## 프로젝트 기간

2023.10 - 2023.11

## 시연 영상

- 추후 추가 예정

## 기술 스택
| Types | Techs |
| -------------- | ----------------------------------- |
| Language | <img src="https://img.shields.io/badge/TypeScript-3178C6?style=flat&logo=TypeScript&logoColor=white"/> |
| Library | <img src="https://img.shields.io/badge/React-61DAFB?style=flat&logo=React&logoColor=white"/> <img src="https://img.shields.io/badge/React Query-FF4154?style=flat&logo=React Query&logoColor=white"/> <img src="https://img.shields.io/badge/React Router-CA4245?style=flat&logo=React Router&logoColor=white"/> <img src="https://img.shields.io/badge/React Hook Form-EC5990?style=flat&logo=reacthookform&logoColor=white"/> |
| Bundler | <img src="https://img.shields.io/badge/vite-646CFF?style=flat&logo=vite&logoColor=white"/> |
| Styling | <img src="https://img.shields.io/badge/Tailwind CSS-06B6D4?style=flat&logo=tailwindcss&logoColor=white"/> <img src="https://img.shields.io/badge/storybook-FF4785?style=flat&logo=storybook&logoColor=white"/> |
| API | <img src="https://img.shields.io/badge/axios-5A29E4?style=flat&logo=axios&logoColor=white"/> |
| Code Formatter | <img src="https://img.shields.io/badge/eslint-4B32C3?style=flat&logo=eslint&logoColor=white"/> <img src="https://img.shields.io/badge/prettier-F7B93E?style=flat&logo=prettier&logoColor=white"/>|

| Types | Techs |
| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Language | <img src="https://img.shields.io/badge/TypeScript-3178C6?style=flat&logo=TypeScript&logoColor=white"/> |
| Library | <img src="https://img.shields.io/badge/React-61DAFB?style=flat&logo=React&logoColor=white"/> <img src="https://img.shields.io/badge/React Query-FF4154?style=flat&logo=React Query&logoColor=white"/> <img src="https://img.shields.io/badge/React Router-CA4245?style=flat&logo=React Router&logoColor=white"/> <img src="https://img.shields.io/badge/React Hook Form-EC5990?style=flat&logo=reacthookform&logoColor=white"/> |
| Bundler | <img src="https://img.shields.io/badge/vite-646CFF?style=flat&logo=vite&logoColor=white"/> |
| Styling | <img src="https://img.shields.io/badge/Tailwind CSS-06B6D4?style=flat&logo=tailwindcss&logoColor=white"/> <img src="https://img.shields.io/badge/ daisyui-1AD1A5?style=flat&logo=daisyui&logoColor=white"/> <img src="https://img.shields.io/badge/storybook-FF4785?style=flat&logo=storybook&logoColor=white"/> |
| API | <img src="https://img.shields.io/badge/axios-5A29E4?style=flat&logo=axios&logoColor=white"/> |
| Code Formatter | <img src="https://img.shields.io/badge/eslint-4B32C3?style=flat&logo=eslint&logoColor=white"/> <img src="https://img.shields.io/badge/prettier-F7B93E?style=flat&logo=prettier&logoColor=white"/> |

## 멤버

<table>
<tr>
<td align="center"><a href="https://github.com/GBAJS754"><img src="https://avatars.githubusercontent.com/GBAJS754" width="130px;" alt=""></a></td>
Expand All @@ -42,4 +76,3 @@ npm run dev
<td align="center"><a href="https://github.com/DongjaJ"><b>정동환</b></a></td>
</tr>
</table>

Loading