Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 37 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,54 +10,55 @@

이 프로젝트는 가상 환경 사용을 권장합니다.

1. **저장소 복제**
```bash
git clone https://github.com/Queryus/QGenie_ai.git
```

2. **가상 환경 생성 및 활성화**
```bash
# 가상 환경 생성 (최초 한 번)
python3 -m venv .venv

# 가상 환경 활성화 (macOS/Linux)
source .venv/bin/activate

# 가상 환경 활성화 (Windows)
.venv\Scripts\activate
```

3. **라이브러리 설치**
프로젝트에 필요한 모든 라이브러리는 `requirements.txt` 파일에 명시되어 있습니다.
```bash
pip install -r requirements.txt
```

4. **실행파일 생성 후 확인**
```bash
# 이전 빌드 결과물 삭제
rm -rf build dist

# 실행 파일 빌드
pyinstaller --clean --onefile --add-data "src/prompts:prompts" --name ai src/main.py
```
1. **저장소 복제**

```bash
git clone https://github.com/Queryus/QGenie_ai.git
```
2. **가상 환경 생성 및 활성화**

```bash
# 가상 환경 생성 (최초 한 번)
python3 -m venv .venv

# 가상 환경 활성화 (macOS/Linux)
source .venv/bin/activate

# 가상 환경 활성화 (Windows)
.venv\Scripts\activate
```
3. **라이브러리 설치**
프로젝트에 필요한 모든 라이브러리는 `requirements.txt` 파일에 명시되어 있습니다.

```bash
pip install -r requirements.txt
```
4. **실행파일 생성 후 확인**

```bash
# 이전 빌드 결과물 삭제
rm -rf build dist

# 실행 파일 빌드
pyinstaller --clean --onefile --add-data "src/prompts:prompts" --name ai src/main.py
```

---

## 📦 배포 방법

~~~markdown
```markdown
태그 예시)
v1.2.3
1 : 큰 버전(기존에 없던 새로운 도메인 추가)
2 : 중간 버전(기존 도메인에 새로운 기능 추가)
3 : 패치 버전(버그 수정, 코드 개선 등)
~~~
```

이 프로젝트는 GitHub Actions를 통해 실행 파일 빌드 및 배포가 자동화되어 있습니다.
GitHub에서 새로운 태그를 발행하면 파이프라인이 자동으로 실행됩니다.

~~~markdown
```markdown
1. 모든 기능 개발과 테스트가 완료된 코드를 main 브랜치에 병합(Merge)합니다.
2. 레포지토리에서 Releases 탭으로 이동하여 Create a new release 버튼을 클릭합니다.
3. Choose a tag 항목을 클릭한후 Find or create a new tag 부분에 버전(v1.0.0)과 같이 새로운 버전 태그를 입력하고 아래 Create new tag를 클릭하여 태그를 생성합니다.
Expand All @@ -68,8 +69,7 @@ GitHub에서 새로운 태그를 발행하면 파이프라인이 자동으로
잘못된 릴리즈는 서비스에 직접적인 영향을 줄 수 있으니, 반드시 팀의 승인을 받고 신중하게 진행해 주십시오.
7. Actions 탭에 들어가 파이프라인을 확인 후 정상 배포되었다면 App 레포에 develop 브랜치에서 실행 파일을 확인합니다.
8. 만약 실패하였다면 인프라 담당자에게 말해주세요.
~~~

```

---

Expand All @@ -82,5 +82,5 @@ GitHub에서 새로운 태그를 발행하면 파이프라인이 자동으로
./dist/ai

# 다른 터미널에서 헬스체크 요청
curl http://localhost:<할당된 포트>/api/v1/health
curl http://localhost:35816/api/v1/health
```
Loading