Merge pull request #345 from Guzzing/dev

docs: 리드미 반영

README.md

@@ -1,2 +1,111 @@
-## Studay_Client
-client 레포지토리입니다.
+## Studay
+### 학원으로 바쁜 내 아이!
+
+그동안 엑셀로 아이 교육비 가계부를 관리했나요?</br>
+주변 학원 조회 데이터를 가져와서 내 아이 스케줄을 만들고 `한 달 교육비를 미리 예상`할 수 있어요
+
+차곡차곡 쌓여진 교육비 데이터를 통해   `교육비 추이`를 쉽게 파악할 수 있도록 통계 자료도 제공합니다!
+
+우리 아이에게  최고의 학원 선택을 할 수 있도록 이 학원 저 학원을 비교해본 경험이 있나요?
+
+다른 학부모가 작성한 태그 학원 리뷰를 통해서 학원에 대한 정보를 확인할 수 있어요.
+
+스터데이를 **통해서 여러 개의 가안을 만들어 보며 `최적의 선택`에 도움을 줄 수 있을 거예요.**
+
+## 🛠 기술스택
+
+<table>
+<tr>
+ <td align="center">언어</td>
+ <td>
+  <img src="https://img.shields.io/badge/TypeScript-3178C6?style=for-the-badge&logo=TypeScript&logoColor=ffffff"/>
+ </td>
+</tr>
+<tr>
+  <td align="center">프레임워크</td>
+  <td>
+   <img src="https://img.shields.io/badge/tailwindcss-%2338B2AC.svg?style=for-the-badge&logo=tailwind-css&logoColor=white"/>&nbsp
+  </td>
+</tr>
+<tr>
+ <td align="center">라이브러리</td>
+ <td>
+    <img src="https://img.shields.io/badge/React-61DAFB?style=for-the-badge&logo=React&logoColor=ffffff"/>&nbsp  
+    <img src="https://img.shields.io/badge/Axios-6028e0?style=for-the-badge&logo=Axios&logoColor=ffffff"/>&nbsp
+    <img src="https://img.shields.io/badge/@tanstack/react query-FF4154?style=for-the-badge&logo=ReactQuery&logoColor=ffffff"/>&nbsp
+  </td>
+</tr>
+<tr>
+ <td align="center">상태관리</td>
+ <td>
+  <img src="https://img.shields.io/badge/Jotai-1678e0?style=for-the-badge"/>&nbsp  
+ </td>
+</tr>
+<tr>
+ <td align="center">패키지</td>
+ <td>
+    <img src="https://img.shields.io/badge/NPM-2C8EBB?style=for-the-badge&logo=NPM&logoColor=white"/>&nbsp 
+  </td>
+</tr>
+<tr>
+ <td align="center">Formatter</td>
+ <td>
+  <img src="https://img.shields.io/badge/Prettier-373338?style=for-the-badge&logo=Prettier&logoColor=ffffff"/>&nbsp 
+  <img src="https://img.shields.io/badge/ESLint-4B32C3?style=for-the-badge&logo=ESLint&logoColor=ffffff"/>&nbsp 
+ </td>
+</tr>
+<tr>
+ <td align="center">배포</td>
+ <td>
+  <img src="https://img.shields.io/badge/S3-FF4100?style=for-the-badge&logo=amazons3&logoColor=white"/>&nbsp
+  <img src="https://img.shields.io/badge/CloudFront-A374DB?style=for-the-badge&logo=amazoncloudwatch&logoColor=white" />&nbsp
+ </td>
+</tr>
+<tr>
+ <td align="center">협업툴</td>
+ <td>
+    <img src="https://img.shields.io/badge/Discord-4263f5?style=for-the-badge&logo=Discord&logoColor=white"/>&nbsp 
+    <img src="https://img.shields.io/badge/GitHub-181717?style=for-the-badge&logo=GitHub&logoColor=white"/>&nbsp 
+    <img src="https://img.shields.io/badge/Slack-4A154B?style=for-the-badge&logo=Slack&logoColor=white"/>&nbsp 
+    <img src="https://img.shields.io/badge/Figma-d90f42?style=for-the-badge&logo=Figma&logoColor=white"/>&nbsp  
+    <img src="https://img.shields.io/badge/Notion-000000?style=for-the-badge&logo=Notion&logoColor=white"/>&nbsp 
+ </td>
+</tr>
+</table>
+
+<br />
+
+
+## 팀원
+
+|                                           Frontend                                           |                                                      Frontend                                                       |                                          Frontend                                          |                                                   
+|:--------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------------------------------------------:|:------------------------------------------------------------------------------------------:|
+| <img width="120" height="120" src="https://avatars.githubusercontent.com/u/106604926?v=4" /> |             <img width="120" height="120" src="https://avatars.githubusercontent.com/u/67894159?v=4" />             |<img width="120" height="120" src="https://avatars.githubusercontent.com/u/85999976?v=4" /> |
+|                            [김희석](https://github.com/HeeSeok-kim)                             |                                         [김유진](https://github.com/eugene028)                                         |                             [김지성](https://github.com/jisung24)                             |
+
+
+
+## ☘ environment variables
+
+<b>.env</b>
+
+```
+VITE_API_ENDPOINT =
+VITE_CLIENT_ID =
+VITE_CLIENT_SECRET = 
+VITE_KAKAO_CLIENT_ID = 
+VITE_KAKAO_CLIENT_SECRET_KEY = 
+VITE_GOOGLE_CLIENT_ID =
+VITE_GOOGLE_CLIENT_SECRET_KEY =
+```
+
+## 🔑 Install
+```
+npm install //package.json으로부터 의존성 모듈 설치
+
+npm run dev //실행
+npm run build //빌드
+npm run mobild //모바일 환경에서 확인
+```
+
+##