From 7b3616bf128d07b3f07c2beffee1b31c54dfd4a3 Mon Sep 17 00:00:00 2001 From: yongaricode Date: Tue, 10 Jun 2025 20:04:13 +0900 Subject: [PATCH] =?UTF-8?q?fix:=20=EB=A6=AC=EB=93=9C=EB=AF=B8=20=ED=8C=8C?= =?UTF-8?q?=EC=9D=BC=20=EC=88=98=EC=A0=95?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 44 ++++++++++++++---- .../readme/architecture.png | Bin 2 files changed, 36 insertions(+), 8 deletions(-) rename "public/readme/\354\213\234\354\212\244\355\205\234 \354\225\204\355\202\244\355\205\215\354\262\230.png" => public/readme/architecture.png (100%) diff --git a/README.md b/README.md index 7d68e63..cd1d17e 100644 --- a/README.md +++ b/README.md @@ -62,32 +62,60 @@ https://github.com/TEAM-ZIP/Backend https://github.com/TEAM-ZIP/AI ``` -### How to Build +### How to Install +
1. Repository 클론 ``` -https://github.com/TEAM-ZIP/Frontend +git clone https://github.com/TEAM-ZIP/Frontend +cd Frontend ```
- 2. npm i + 2. 의존성 설치 ``` npm install ``` -- git clone을 하면 npm 패키지가 없기 때문에 설치가 필요합니다. +- git clone을 하면 의존성 패키지들이 없기 때문에 설치가 필요합니다. - npm이 있는 폴더에서 npm i 를 진행해야합니다. -- 설치가 완료되면 package-lock.json 과 package.json 파일이 생성됩니다. +- 설치 완료 시 node_modules 폴더가 생성됩니다.
-3. 빌드 +3. 개발 서버 실행 ``` npm run dev ``` -터미널에서 npm run dev를 실행하면 웹 페이지를 확인할 수 있습니다.
+- 터미널에서 npm run dev를 실행하면 개발 서버가 실행되고 브라우저에서 확인할 수 있습니다.
+ +### How to Build (Production) + +
+ +``` +npm run build +``` + +- 배포용 빌드 파일이 dist 폴더에 생성됩니다. + +### How to Test + +
+1. 로컬 환경에서 테스트: + +``` +npm run build +``` + +- 개발 서버 실행 후 http://localhost:5173에서 기능 테스트 가능 + +
+2. 배포된 사이트에서 테스트: + +- [서점 ZIP가기](https://reactjs.org/)에서 모든 기능 확인 가능 --- @@ -99,7 +127,7 @@ npm run dev ## 📍 아키텍처 -![alt text]() +![alt text](public/readme/architecture.png) ## 🗂️ 폴더 구조 diff --git "a/public/readme/\354\213\234\354\212\244\355\205\234 \354\225\204\355\202\244\355\205\215\354\262\230.png" b/public/readme/architecture.png similarity index 100% rename from "public/readme/\354\213\234\354\212\244\355\205\234 \354\225\204\355\202\244\355\205\215\354\262\230.png" rename to public/readme/architecture.png