[feat] README 작성

README.md

@@ -1,73 +1,44 @@
-# React + TypeScript + Vite
+## 프로젝트
+- 이름 : Clinic AD
 
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+## 기술 스택
+- React 19 + TypeScript
+- Vite
+- Tailwind CSS
+- TanStack Query
+- Zustand
 
-Currently, two official plugins are available:
+## 디렉토리 구조
 
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Oxc](https://oxc.rs)
+디렉토리 구조는 다음을 따를 예정입니다.
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/)
+```bash
-
+src/
-## React Compiler
+├── app/              # 애플리케이션 진입점 및 전역 설정 (Router, Providers, 글로벌 스타일)
-
+├── assets/           # 정적 파일 (이미지, 폰트, 로티 애니메이션 등)
-The React Compiler is not enabled on this template because of its impact on dev & build performances. To add it, see [this documentation](https://react.dev/learn/react-compiler/installation).
+├── components/       # 도메인에 종속되지 않는 공통 UI 컴포넌트 (버튼, 모달, 디자인 시스템)
-
+├── features/         # 핵심 비즈니스 로직 및 도메인 영역 (이 구조의 핵심)
-## Expanding the ESLint configuration
+│   ├── auth/         # 특정 도메인 (예: 인증)
-
+│   │   ├── api/      # 해당 도메인 전용 API 통신 함수
-If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:
+│   │   ├── hooks/    # 해당 도메인 전용 커스텀 훅
-
+│   │   ├── store/    # 해당 도메인 전용 상태 (Zustand 등)
-```js
+│   │   ├── types/    # 해당 도메인 전용 타입 정의
-export default defineConfig([
+│   │   └── ui/       # 해당 도메인 전용 UI 컴포넌트
-  globalIgnores(['dist']),
+├── hooks/            # 전역에서 사용하는 공통 훅 (useClickOutside 등)
-  {
+├── layouts/          # 페이지 레이아웃 (GNB, Sidebar, 풋터 등)
-    files: ['**/*.{ts,tsx}'],
+├── pages/            # 라우팅과 1:1 매칭되는 페이지 진입점 (여기서는 features의 컴포넌트만 조립)
-    extends: [
+├── services/         # 공통 API 클라이언트 설정 (Axios 인스턴스, 인터셉터 등)
-      // Other configs...
+├── store/            # 전역 상태 관리 (사용자 세션, 테마 등)
-
+└── utils/            # 공통 유틸리티 함수 (날짜 포맷팅, 정규식 등)
-      // Remove tseslint.configs.recommended and replace with this
-      tseslint.configs.recommendedTypeChecked,
-      // Alternatively, use this for stricter rules
-      tseslint.configs.strictTypeChecked,
-      // Optionally, add this for stylistic rules
-      tseslint.configs.stylisticTypeChecked,
-
-      // Other configs...
-    ],
-    languageOptions: {
-      parserOptions: {
-        project: ['./tsconfig.node.json', './tsconfig.app.json'],
-        tsconfigRootDir: import.meta.dirname,
-      },
-      // other options...
-    },
-  },
-])
 ```
 
-You can also install [eslint-plugin-react-x](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) for React-specific lint rules:
+## 시작하기
 
-```js
+### 설치
-// eslint.config.js
+```bash
-import reactX from 'eslint-plugin-react-x'
+npm install
-import reactDom from 'eslint-plugin-react-dom'
-
-export default defineConfig([
-  globalIgnores(['dist']),
-  {
-    files: ['**/*.{ts,tsx}'],
-    extends: [
-      // Other configs...
-      // Enable lint rules for React
-      reactX.configs['recommended-typescript'],
-      // Enable lint rules for React DOM
-      reactDom.configs.recommended,
-    ],
-    languageOptions: {
-      parserOptions: {
-        project: ['./tsconfig.node.json', './tsconfig.app.json'],
-        tsconfigRootDir: import.meta.dirname,
-      },
-      // other options...
-    },
-  },
-])
 ```
+
+### 실행
+```bash
+npm run dev
+```