Skip to content

JungHyunMoon/pangyo-dialect-generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 

Repository files navigation

FastAPI 판교 사투리 변환기

📌 프로젝트 개요

FastAPI를 사용하여 일반 한국어 문장을 판교 사투리로 변환하는 API 서버입니다.

🚀 실행 방법

1. 가상 환경 설정 (선택 사항)

Python 가상 환경을 사용하고 싶다면 아래 명령어를 실행하세요.

python -m venv venv
source venv/bin/activate  # macOS/Linux
venv\Scripts\activate    # Windows

2. 필요한 패키지 설치

프로젝트 실행에 필요한 패키지를 설치합니다.

pip install -r requirements.txt

3. 환경 변수 설정

.env 파일을 생성하고 다음 내용을 추가하세요.

OPENAI_API_KEY=your_openai_api_key

이 API 키가 없으면 OpenAI 관련 기능이 동작하지 않습니다.

4. 서버 실행

아래 명령어로 FastAPI 서버를 실행할 수 있습니다.

uvicorn backend.main:app --port 8080

5. API 접근 경로

기능 경로
홈 경로 http://localhost:8080/home
API 문서 (Swagger UI) http://localhost:8080/docs
API 문서 (ReDoc) http://localhost:8080/redoc

📡 API 사용 방법

🔹 판교 사투리 변환 API

  • 엔드포인트: /convert
  • 메서드: POST
  • 요청 형식: JSON
    {
      "input_text": "문제를 상위 관리자에게 보고하다"
    }
  • 응답 형식: JSON
    {
      "output_text": "문제를 에스컬레이션하다"
    }

⚙️ 폴더 구조

backend/
│── main.py   
frontend/
│── index.html
│── script.js 
│── style.css 

📌 기타 사항

  • 서버 실행 시 --reload 옵션을 사용하면 코드 변경 시 자동으로 재시작됩니다.
    uvicorn backend.main:app --port 8080 --reload

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published