Skip to content

Commit e3e09a8

Browse files
authored
Merge pull request #280 from MBTips/Soohyuniii-patch-3
Update README.md
2 parents e12c29a + ac13021 commit e3e09a8

File tree

1 file changed

+63
-50
lines changed

1 file changed

+63
-50
lines changed

README.md

Lines changed: 63 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,63 @@
1-
# React + TypeScript + Vite
2-
3-
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
4-
5-
Currently, two official plugins are available:
6-
7-
- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
8-
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
9-
10-
## Expanding the ESLint configuration
11-
12-
If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
13-
14-
- Configure the top-level `parserOptions` property like this:
15-
16-
```js
17-
export default tseslint.config({
18-
languageOptions: {
19-
// other options...
20-
parserOptions: {
21-
project: ['./tsconfig.node.json', './tsconfig.app.json'],
22-
tsconfigRootDir: import.meta.dirname,
23-
},
24-
},
25-
})
26-
```
27-
28-
- Replace `tseslint.configs.recommended` to `tseslint.configs.recommendedTypeChecked` or `tseslint.configs.strictTypeChecked`
29-
- Optionally add `...tseslint.configs.stylisticTypeChecked`
30-
- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and update the config:
31-
32-
```js
33-
// eslint.config.js
34-
import react from 'eslint-plugin-react'
35-
36-
export default tseslint.config({
37-
// Set the react version
38-
settings: { react: { version: '18.3' } },
39-
plugins: {
40-
// Add the react plugin
41-
react,
42-
},
43-
rules: {
44-
// other rules...
45-
// Enable its recommended rules
46-
...react.configs.recommended.rules,
47-
...react.configs['jsx-runtime'].rules,
48-
},
49-
})
50-
```
1+
# MBTips - 성격 유형 기반 팁 공유 플랫폼
2+
3+
🌐 [https://mbtips.kr](https://mbtips.kr)
4+
5+
MBTips는 MBTI 성격 유형에 따라 다양한 상황별 팁을 확인하고, 다른 유형과 소통할 수 있는 웹 서비스입니다.
6+
사용자는 상대의 성격 유형을 유추해보거나, 유형별 상황 대응법을 확인하고, 궁금한 MBTI와 실시간 채팅을 통해 대화를 나눌 수 있습니다.
7+
8+
> ⏱️ **개발 기간**: 2025년 2월 ~ 2025년 5월 (약 4개월)
9+
> 🎨 **프론트엔드 담당**: UI/UX 설계, 컴포넌트 구현, 상태 관리, 라우팅 및 API 연동
10+
11+
---
12+
13+
## 🧩 주요 기능
14+
15+
- 🔍 **상대 MBTI 추측 검사하기**
16+
질문에 답하면서 상대방의 MBTI를 유추해보는 인터랙티브 검사
17+
18+
- 💡 **MBTI별 상황별 팁 보기**
19+
유형별로 상황(연애 등)에 따른 대화 팁과 조언 제공
20+
21+
- 💬 **MBTI별 채팅 기능**
22+
내가 궁금한 MBTI 유형과 실시간 채팅으로 대화 체험
23+
24+
---
25+
26+
## 🚀 기술 스택
27+
28+
### 프론트엔드
29+
30+
| 기술 | 설명 |
31+
|------|------|
32+
| **React 18** | SPA 프레임워크 |
33+
| **Vite 6** | 빠른 번들링 및 개발 서버 |
34+
| **TypeScript** | 정적 타입 지원 |
35+
| **Zustand** | 상태 관리 라이브러리 |
36+
| **React Router DOM v7** | 클라이언트 사이드 라우팅 |
37+
| **Tailwind CSS 4** | 유틸리티 기반 CSS 프레임워크 |
38+
| **Axios** | HTTP 클라이언트 |
39+
| **React GA4** | 구글 애널리틱스 연동 |
40+
| **ESLint + Prettier** | 코드 스타일 자동화
41+
42+
---
43+
44+
## 📁 프로젝트 구조
45+
46+
```bash
47+
src/
48+
├── api/ # API 요청 함수 모음
49+
├── components/ # 재사용 가능한 UI 컴포넌트
50+
├── constants/ # 상수 정의 (ex. MBTI 목록, 메시지 등)
51+
├── hooks/ # 커스텀 React Hooks
52+
├── libs/ # 외부 라이브러리 래퍼 (예: GA 등)
53+
├── mock/ # 목업 데이터 및 정적 페이지용 데이터
54+
├── pages/ # 라우팅되는 주요 페이지 컴포넌트
55+
├── store/ # Zustand를 활용한 상태 관리
56+
├── types/ # 전역 TypeScript 타입 정의
57+
├── utils/ # 공통 유틸리티 함수
58+
├── App.tsx # 루트 컴포넌트
59+
├── main.tsx # 앱 진입점
60+
├── index.css # 글로벌 스타일
61+
├── global.d.ts # 글로벌 타입 선언
62+
├── vite-env.d.ts # Vite 환경 타입 선언
63+
└── ...

0 commit comments

Comments
 (0)