From ad4627f383d8604a5001f996c07648df0659923b Mon Sep 17 00:00:00 2001 From: mh97 Date: Mon, 16 Mar 2026 15:41:37 +0900 Subject: [PATCH] =?UTF-8?q?[feat]=20README=20=EC=9E=91=EC=84=B1?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 103 ++++++++++++++++++++---------------------------------- 1 file changed, 37 insertions(+), 66 deletions(-) diff --git a/README.md b/README.md index 7dbf7eb..c206def 100644 --- a/README.md +++ b/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/) - -## React Compiler - -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). - -## Expanding the ESLint configuration - -If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules: - -```js -export default defineConfig([ - globalIgnores(['dist']), - { - files: ['**/*.{ts,tsx}'], - extends: [ - // Other configs... - - // 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... - }, - }, -]) +디렉토리 구조는 다음을 따를 예정입니다. +```bash +src/ +├── app/ # 애플리케이션 진입점 및 전역 설정 (Router, Providers, 글로벌 스타일) +├── assets/ # 정적 파일 (이미지, 폰트, 로티 애니메이션 등) +├── components/ # 도메인에 종속되지 않는 공통 UI 컴포넌트 (버튼, 모달, 디자인 시스템) +├── features/ # 핵심 비즈니스 로직 및 도메인 영역 (이 구조의 핵심) +│ ├── auth/ # 특정 도메인 (예: 인증) +│ │ ├── api/ # 해당 도메인 전용 API 통신 함수 +│ │ ├── hooks/ # 해당 도메인 전용 커스텀 훅 +│ │ ├── store/ # 해당 도메인 전용 상태 (Zustand 등) +│ │ ├── types/ # 해당 도메인 전용 타입 정의 +│ │ └── ui/ # 해당 도메인 전용 UI 컴포넌트 +├── hooks/ # 전역에서 사용하는 공통 훅 (useClickOutside 등) +├── layouts/ # 페이지 레이아웃 (GNB, Sidebar, 풋터 등) +├── pages/ # 라우팅과 1:1 매칭되는 페이지 진입점 (여기서는 features의 컴포넌트만 조립) +├── services/ # 공통 API 클라이언트 설정 (Axios 인스턴스, 인터셉터 등) +├── store/ # 전역 상태 관리 (사용자 세션, 테마 등) +└── utils/ # 공통 유틸리티 함수 (날짜 포맷팅, 정규식 등) ``` -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 -import reactX from 'eslint-plugin-react-x' -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 install ``` + +### 실행 +```bash +npm run dev +``` \ No newline at end of file