diff --git a/README.md b/README.md index e69de29..7d68e63 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,138 @@ +# 서점ZIP + +![alt text]() + +## 프로젝트 개요 + +이 프로젝트는 개인만의 특성을 드러내는 독립출판물의 감성을 즐기는 사용자가 독립출판물을 더 잘 찾아낼 수 있도록, 독립출판물을 비치한 서점에 대한 위치, 키워드, 운영시간 등의 정보와 도서출판전산망에 등록되지 않은 독립출판물 리뷰 제공 및 추천 시스템을 제공합니다. + +### 주요 기능 + +![alt text]() + +1. **BOOKSNAP** (사용자 리뷰 기반 독립출판물 데이터 구축) + + - 사용자가 직접 독립출판물에 대한 리뷰를 등록 (책 제목, 작가, 평점, 서점 사진 등) + - 사용자 참여 기반 데이터를 구축하여 독립출판물 정보를 확보 + - 축적된 리뷰 데이터를 활용하여 추천 시스템 학습 데이터로 활용 가능 + +2. **서점 ZIP** (지도 기반 서점 탐색) + - 사용자의 현재 위치 또는 검색 위치를 기준으로 주변 독립서점을 지도에서 시각화 + - Kakao 지도 API 및 거리 계산 알고리즘을 활용하여 위치 기반 필터링, 태그 기반 분류 지원 + - 서점별 보유 도서, 운영 시간, 태그 정보 등 상세 정보 제공 +3. **Bookie** (RAG 기반 독립출판물 추천) + +- LLM + Vector DB를 활용한 RAG 기반 AI 추천 시스템 +- 사용자 리뷰, 검색, 찜 목록 등의 활동 데이터를 바탕으로 개인화된 독립출판물 추천 +- 챗봇 인터페이스를 통해 직관적인 추천 경험 제공 + +### 부가 기능 + +![부가 기능]() + +### 사용 기술 + +![GitHub](https://img.shields.io/badge/GitHub-181717?style=flat-square&logo=github&logoColor=white) +![Swagger](https://img.shields.io/badge/Swagger-85EA2D?style=flat-square&logo=swagger&logoColor=white) +![React](https://img.shields.io/badge/React-61DAFB?style=flat-square&logo=react&logoColor=white) +![Typescript](https://img.shields.io/badge/Typescript-3178C6?style=flat-square&logo=Typescript&logoColor=white) +![Axios](https://img.shields.io/badge/Axios-5A29E4?style=flat-square&logo=axios&logoColor=white) +![Tailwind](https://img.shields.io/badge/TailwindCSS-06B6D4?style=flat-square&logo=TailwindCSS&logoColor=white) +![AWS](https://img.shields.io/badge/AmazonAWS-232F3E?style=flat-square&logo=amazonaws&logoColor=white) +![Zustand](https://img.shields.io/badge/zustand-orange?style=flat-square&logo=zustand&logoColor=white) + +--- + +## 시작하기 + +### 사전준비 + +프론트를 실행하기 전에 서버 실행이 선행되어야 합니다.
+서버 실행관련한 깃헙 레포를 첨부합니다. + +- 백앤드 + +``` +https://github.com/TEAM-ZIP/Backend +``` + +- AI + +``` +https://github.com/TEAM-ZIP/AI +``` + +### How to Build + +1. Repository 클론 + +``` +https://github.com/TEAM-ZIP/Frontend +``` + +
+ 2. npm i + + ``` +npm install + ``` +- git clone을 하면 npm 패키지가 없기 때문에 설치가 필요합니다. +- npm이 있는 폴더에서 npm i 를 진행해야합니다. +- 설치가 완료되면 package-lock.json 과 package.json 파일이 생성됩니다. + +
+3. 빌드 + +``` +npm run dev +``` + +터미널에서 npm run dev를 실행하면 웹 페이지를 확인할 수 있습니다.
+ +--- + +## 👋🏻 Members + +| | +| :-------------------------------------------------------: | +| [강다형](https://github.com/yongaricode) | + +## 📍 아키텍처 + +![alt text]() + +## 🗂️ 폴더 구조 + +``` + +📂 BookstoreZIP/ +│ +├─ 📂 public ▶️ Static assets (favicon, images, etc.) +│ +├─ 📂 src ▶️ Source code +│ ├─ 📂 api ▶️ API communication files +│ ├─ 📂 assets ▶️ Images, icons and resources +│ ├─ 📂 components ▶️ Reusable React components +│ ├─ 📂 pages ▶️ Page components +│ ├─ 📂 routes ▶️ Routing configuration +│ ├─ 📂 style ▶️ Global styles +│ ├─ App.tsx ▶️ Main App component +│ └─ main.tsx ▶️ Application entry point +│ +├─ dist/ ▶️ Built files (for deployment) +│ +└─ package.json ▶️ Project configuration and dependencies + +``` + +
+ +## 📚 오픈소스 + +## Frontend Libraries & Tools + +1. **React**: [React Official Site](https://reactjs.org/) +2. **Axios**: [Axios Official Site](https://axios-http.com/) +3. **TailwindCSS**: [TailwindCSS Official Site](https://tailwindcss.com/) +4. **Prettier**: [Prettier Official Site](https://prettier.io/) +5. **Zustand**: [Zustand Offilcial Site](https://zustand-demo.pmnd.rs/) diff --git a/public/readme/Slide 16_9 - 1.png b/public/readme/Slide 16_9 - 1.png new file mode 100644 index 0000000..26cafca Binary files /dev/null and b/public/readme/Slide 16_9 - 1.png differ diff --git a/public/readme/Slide 16_9 - 31.png b/public/readme/Slide 16_9 - 31.png new file mode 100644 index 0000000..d5c63e6 Binary files /dev/null and b/public/readme/Slide 16_9 - 31.png differ diff --git a/public/readme/Slide 16_9 - 51.png b/public/readme/Slide 16_9 - 51.png new file mode 100644 index 0000000..7841b34 Binary files /dev/null and b/public/readme/Slide 16_9 - 51.png differ 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/\354\213\234\354\212\244\355\205\234 \354\225\204\355\202\244\355\205\215\354\262\230.png" new file mode 100644 index 0000000..2fbad22 Binary files /dev/null and "b/public/readme/\354\213\234\354\212\244\355\205\234 \354\225\204\355\202\244\355\205\215\354\262\230.png" differ