Skip to content

Commit 0a7fc67

Browse files
committed
๐Ÿ“ Doc(readme): Add readme
1 parent d1138a5 commit 0a7fc67

1 file changed

Lines changed: 50 additions & 7 deletions

File tree

โ€ŽREADME.mdโ€Ž

Lines changed: 50 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,55 @@
1-
# React + Vite
1+
# ๐Ÿš€ ์Šคํ„ฐ๋”” ํŠธ๋ž˜์ปค: ์–ผ๋งˆ๋‚˜ ๋ฐฐ์› ๊ณ  ์–ผ๋งˆ๋‚˜ ์ตํ˜”๋‹ˆ
22

3-
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
3+
## ๐Ÿ“– ์†Œ๊ฐœ
4+
์Šคํ„ฐ๋”” ํŠธ๋ž˜์ปค๋Š” ํ•™์ƒ์˜ ์ˆ˜์—…์„ ์ฒด๊ณ„์ ์œผ๋กœ ๊ณ„ํšํ•˜๊ณ  ์ ๊ฒ€ํ•˜๊ฒŒ ํ•ด์ฃผ๋Š” ํ’€์Šคํƒ ์›น ์•ฑ์ž…๋‹ˆ๋‹ค
45

5-
Currently, two official plugins are available:
6+
๋ฐฑ์—”๋“œ ํ”„๋กœ์ ํŠธ๋Š” ์•„๋ž˜์˜ ๋งํฌ์—์„œ ํ™•์ธํ•˜์„ธ์š”
7+
https://github.com/ThePott/study-tracker-api-sql
68

7-
- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Babel](https://babeljs.io/) for Fast Refresh
8-
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
9+
## โœจ ์ฃผ์š” ๊ธฐ๋Šฅ
10+
1. ์นธ๋ฐ˜๋ณด๋“œ๋กœ ํ•œ ๋ˆˆ์— ํŒŒ์•…ํ•˜๋Š” ์ „ ์ˆ™์ œ, ์˜ค๋Š˜ ํ•  ๊ฒƒ, ์ƒˆ ์ˆ™์ œ
11+
2. ํ˜„์žฌ ์ง„ํ–‰ ์ƒํ™ฉ์„ ํ•œ ๋ˆˆ์— ๋ณผ ์ˆ˜ ์žˆ๋Š” ์ง„๋„ํ‘œ
12+
3. ๋ณต์Šตํ•  ๋ฌธ์ œ๋ฅผ ์ฒดํฌํ•˜๋Š” ์˜ค๋‹ต ์ฒดํฌ
913

10-
## Expanding the ESLint configuration
14+
## ๐Ÿงญ ๋ผ์šฐํ„ฐ ๊ตฌ์กฐ
15+
```
16+
/ โ†’ ์ž„์‹œ ๋กœ๊ทธ์ธ, ๋กœ๊ทธ์•„์›ƒ ํŽ˜์ด์ง€
17+
/manage โ†’ ์ž„์‹œ ํ•™์ƒ ๊ด€๋ฆฌ ํŽ˜์ด์ง€
18+
/summary โ†’ ์ˆ˜์—… ์š”์•ฝ ํŽ˜์ด์ง€
19+
/progress โ†’ ์ง„๋„ํ‘œ ํŽ˜์ด์ง€
20+
/review-check โ†’ ์˜ค๋‹ต ์ฒดํฌ ํŽ˜์ด์ง€
21+
```
1122

12-
If you are developing a production application, we recommend using TypeScript with type-aware lint rules enabled. Check out the [TS template](https://github.com/vitejs/vite/tree/main/packages/create-vite/template-react-ts) for information on how to integrate TypeScript and [`typescript-eslint`](https://typescript-eslint.io) in your project.
23+
## ๐Ÿ› ๏ธ ๊ธฐ์ˆ  ์Šคํƒ
24+
25+
### Frontend & Framework
26+
![React](https://img.shields.io/badge/react-19.1.0-61DAFB?style=for-the-badge&logo=react&logoColor=white)
27+
![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white)
28+
![React Router](https://img.shields.io/badge/React_Router-7.6.2-CA4245?style=for-the-badge&logo=react-router&logoColor=white)
29+
30+
### UI & Styling
31+
![Material-UI](https://img.shields.io/badge/MUI-7.1.1-0081CB?style=for-the-badge&logo=mui&logoColor=white)
32+
![TailwindCSS](https://img.shields.io/badge/tailwindcss-4.1.8-38B2AC?style=for-the-badge&logo=tailwind-css&logoColor=white)
33+
34+
### State Management & Tools
35+
![Zustand](https://img.shields.io/badge/zustand-5.0.6-FF6B35?style=for-the-badge)
36+
![Axios](https://img.shields.io/badge/axios-1.10.0-5A29E4?style=for-the-badge&logo=axios&logoColor=white)
37+
38+
### Development Tools
39+
![Vite](https://img.shields.io/badge/vite-6.3.5-646CFF?style=for-the-badge&logo=vite&logoColor=white)
40+
![ESLint](https://img.shields.io/badge/ESLint-9.25.0-4B3263?style=for-the-badge&logo=eslint&logoColor=white)
41+
42+
43+
44+
## ๐Ÿ“ฆ ์„ค์น˜
45+
ํ”„๋กœ์ ํŠธ๋ฅผ ์„ค์น˜ํ•˜๊ณ  ์‹ถ์€ ๋””๋ ‰ํ† ๋ฆฌ์—์„œ ์•„๋ž˜ ๋ช…๋ น์–ด๋ฅผ ์ž…๋ ฅํ•˜์„ธ์š”
46+
```bash
47+
git clone https://github.com/ThePott/study-tracker
48+
cd study-tracker
49+
npm install
50+
```
51+
## โœ… ์š”๊ตฌ์‚ฌํ•ญ
52+
* Node.js
53+
54+
## ๐Ÿ“œ ๋ผ์ด์„ผ์Šค
55+
MIT

0 commit comments

Comments
ย (0)