f-lab-edu / what-cat-eat

뭐먹냥 / 고양이 사료 선호도 기록 서비스

뭐먹냥(What-cat-eat)

고양이 사료 선호도 기록 서비스입니다. 고양이가 선호하는 사료들을 기록하고 알러지가 있다면 알러지 내용도 기록할 수 있습니다. 또한 커뮤니티 공간을 통해 집사들간 소통도 가능합니다.

목차

• 프로젝트 실행 방법
• 테스트 코드 동작 방법
• 사용기술

프로젝트 실행 방법

1. homebrew 설치

$ xcode-select --install
$ ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

2. 파이썬 설치하기 (python 3.10.6버전)

$ brew install python3.10.6
$ python3 --version

3. 가상환경 설치 및 진입

$ python3 -m venv env
$ source env/bin/activate

4. 필요 라이브러리 설치

• fastapi
• uvicorn : ASGI web server
• SQLAlchemy : Python용 ORM
• alembic : 데이터베이스 마이그레이션 도구
• bcrypt : 패스워드 암호화
• flake8 : 코드 Lint용 도구
• black : 코드 Lint용 도구
• pytest : 테스트 코드 작성용
• httpx : 테스트 코드 작성용

$ pip install -r requrements.txt

5. DB 초기화 및 alembic 세팅

$ alembic init migrations
$ alembic revision --autogenerate
$ alembic upgrade head

6. 서버 실행하기(FastAPI)

$ uvicorn main:app --reload

테스트 코드 동작 방법

1. pytest 설치

$ pip install pytest

2. 실행

python -m pytest tests

Docker 실행 방법

1. docker 이미지 만들기

docker build -t myimage .

2. 컨테이너 만들기

docker run -d --name mycontainer -p 80:80 myimage

사용 기술

1. FastAPI
2. Python3.10

what-cat-eat's Issues

JWT를 이용한 로그인 기능 작성

What To Do

• Service/Repository 패턴을 적용하여 로그인 기능 작성하기
• 로그인 방법
  1. 아이디, 비밀번호를 form 형태로 받는다.
  2. 아이디, 비밀번호가 등록이 되어있는지 확인한다.
  3. 되어있다면 토큰을 만든다.
  4. 만든 토큰을 response한다.

로그인 테스트 코드 작성

What To Do

• 아이디를 잘못 입력했을 경우
• 비밀번호를 잘못 입력했을 경우
• 로그인에 성공했을 경우

클린 아키텍쳐 적용

TODO

• #8
• #6

HOW

• 파이썬으로 살펴보는 아키텍쳐 패턴을 읽고 Repository 패턴을 적용합니다.
• API 👉 Service 👉 Repository 흐름 적용

Push 할 때 마다 test 코드 동작(Git Action)

DB 이슈 해결 및 DB 변경

TODO

• #4
• #5

DB 서버 이전(AWS -> NCP)

mock을 이용한 테스트코드 작성

What To Do

• mock과 Fake Repository를 이용한 테스트 코드 작성
  • CRUD 테스트
  • nickname unique 필드 테스트
  • max size 확인 테스트

User CRUD 완성

Definition

• 프로젝트 구조를 세팅
  • DB 연동 및 초기 설정
  • README, 테스트 코드, 소스 코드 디렉토리 구조
• 회원 관련 CRUD API 제공
  • API Endpoint, Request-Response 포맷 세팅

User login 기능 작성

TODO

• #16
• #17
• #24

HOW

• OAuth2를 이용하여 로그인에 성공하면 JWT 토큰을 발급받도록 합니다.

발생한 문제

• 비밀번호 verify 에러
  https://velog.io/@heyoni/jwt-token-with-error

Refresh token 적용하기

TODO

• 재요청 시 토큰이 만료되었다는 에러 발생

HOW

• refresh token 사용하여 해결합니다.

성능테스트

TODO

• locust를 이용한 성능테스트

코드 구조 변경

What To Do

• 클린아키텍쳐 패턴 적용
  (파이썬으로 살펴보는 아키텍쳐 패턴, 클린아키텍쳐 참고)
• Repository 패턴 및 AbstractRepository 적용
• Service 패턴 적용

고양이 정보 CRUD 작성

TODO

• 고양이 정보 CRUD 기능 작성
• 테스트 코드 작성

HOW

• 회원가입한 사용자에 대해 고양이 정보를 등록할 수 있도록 합니다.

Docker 도입

DB table 생성이 안되는 문제 해결

Authentication 적용

TODO

• 로그인 이후 가능한 작업들 Authentication 적용하기
  • 내 프로필 조회하기(user_id가 나와야 함)
  • 내 프로필 수정하기
  • 탈퇴하기

HOW

• 로그인 이후 발급 받은 토큰이 있을 경우에만 동작하도록 합니다.

PetFood 작성하기

TODO

• PetFood(사료) 작성하기
• 테스트 코드 작성하기

Docker Postgres 연결

CI/CD 적용, DB 서버 이전

TODO

• #11
• #12
• #19

HOW

• Git Action으로 push 후 테스트 코드를 자동으로 동작하게 합니다.
• Docker 도입 후 기본 설정
• DB 서버를 AWS에서 NCP로 이전합니다.

발생한 문제

• ACG 설정 문제
  https://velog.io/@heyoni/AWS-to-NCP-with-postgresql

Poetry로 파이썬 패키지 관리하기

TODO

• Poetry 설치 및 세팅

HOW

• 파이썬 패키지 관리 툴 Poetry를 설치하고 세팅합니다.

PostgreSQL로 변경하기