README.md

티켓 사진 OCR 서버

티켓 사진의 텍스트로 추출하는 FastAPI 기반 프로젝트
✔ 배포 웹사이트 : 배포 이전 상태
✔ Tech : FastAPI, SQLAlchemy, pydantic, postgresql, JWT, Alembic, Docker, AWS

Convention

• Camel Case(클래스)와 Snake Case(함수명) 구분
• 중복된 파라미터 최소화
• 함수에 대한 정의는 """로 시작
• 타입 힌트
• 주석은 최소화 + 코드 위에 간결하게 작성
• 비슷한 함수는 클래스로 묶기
• 미래에 쓸 것 같은 코드는 과감히 제외 (정말 쓸거라면 # TODO 주석으로)

Summary

• 사진의 텍스트를 추출하는 AI 서버

Skils

언어 및 프레임워크:
데이터베이스 및 테스트:
배포 :

Installation

1. 환경변수 설정

   SECRET_KEY=e068f0399d3729db42eafdc56ca258ff3954c38a24ac423a6d5b15005378785c

2. 라이브러리 설치(python 3.9버전)

      pip install requirements.txt

3. 엘리스 미니 프로젝트 실행

   alembic upgrade head
   uvicorn main:app --reload

   • http://127.0.0.1:8000/docs

디렉터리 구조

• 3-Tier Architecture 방식 적용
• 관련 TIL : [ocr #3] 디렉터리 구조화

├─app
│  ├─config
│  ├─models
│  ├─routers
│  ├─schemas
│  ├─services
├─migrations
│  ├─versions
├─tests
│  └─routers

AI 협업 방법

1. 가상환경 활성화(3.9버전)
2. pip install -r requirements.txt
3. uvicorn main:app --reload
4. 127.0.0.1:8000/docs 열기
5. ocr 분석 실행
6. run_ocr 잘 되는지 확인
7. git push 또는 pr 올리기

Git Convention

• github-flow를 따름
• branch Convention

    issuename_#10
  

• commit Convention

  Feat #10 : 특정 기능 추가
  

Running Tests

Test => tests 폴더 Run

API 문서

API 문서 바로가기👈

Architecture

TIL

전체 TIL 링크

• Elice Mini Project

각 TIL 링크

• [ocr #1] Fast API PostgreSQL 환경 구축 & CRUD
• [ocr #3] ERD 설계 & CRUD
• [ocr #3] 디렉터리 구조화
• [ocr #3] Test Code 작성하기
• [ocr #7] 비밀번호 암호화 관련 라이브러리 오류
• [ocr #7] JWT 검증 로직 추가
• [ocr #8] pagination 기능
• [ocr #10] 데이터베이스 Alembic 도입 과정
• [ocr #11] docker-compose 적용하기