diff --git a/README.md b/README.md index 2b58bd3..160ed64 100644 --- a/README.md +++ b/README.md @@ -10,8 +10,6 @@ - **자연어 질의응답**: Google의 Gemini 모델을 통해 사용자의 자연어 질문을 이해하고 지능적인 답변을 생성합니다. - **동적 명세 새로고침**: UI의 버튼 클릭 한 번으로 최신 API 명세를 원격 URL에서 다시 가져와 앱에 반영할 수 있습니다. - **한국어 지원**: 모든 답변은 한국어로 제공됩니다. -- **직관적인 UI**: Streamlit을 사용하여 사용하기 쉬운 웹 기반 채팅 인터페이스를 제공하며, ���고 및 커스텀 스타일이 적용되어 있습니다. -- **컨테이너화**: Docker 및 Docker Compose를 사용하여 개발 환경에 구애받지 않고 일관된 실행 환경을 제공합니다. ## 🛠️ 기술 스택 @@ -50,11 +48,13 @@ chatbot_app/ 2. **정적 파일 배치**: `chatbot_app/static/` 디렉토리 안에 다음 두 파일을 위치시킵니다. + - `api_spec.json`: 조회할 대상의 OpenAPI 명세 파일 - `logo.png`: UI 사이드바에 표시할 로고 이미지 3. **환경 변수 설정**: `chatbot_app/.env.chatbot` 파일을 열고, `YOUR_GEMINI_API_KEY` 부분을 실제 발급받은 Google Gemini API 키로 교체합니다. + ```env # YOUR_GEMINI_API_KEY를 실제 키로 변경하세요. GOOGLE_API_KEY="YOUR_GEMINI_API_KEY" @@ -62,9 +62,11 @@ chatbot_app/ 4. **애플리케이션 빌드 및 실행**: 터미널에서 `chatbot_app` 디렉토리로 이동한 후, 다음 명령어를 실행합니다. + ```bash docker-compose up --build -d ``` + - `--build`: 이미지를 새로 빌드합니다. (코드 변경 시 필요) - `-d`: 컨테이너를 백그라운드에서 실행합니다.