Skip to content

Commit

Permalink
feat: Readme 업데이트 (postman 유저 등록 설명 추가)
Browse files Browse the repository at this point in the history
  • Loading branch information
JAY-Chan9yu committed Jan 4, 2023
1 parent 1dfda84 commit c52b44c
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,9 @@ DB는 `MySQL`을 사용하며 비동기 처리를 위해 `aiomysql`라이브러
<br/>

## 🐳 Docker-Compose 실행
`.env`파일을 생성한뒤 `docker-compose up -d` 를 실행합니다.<br/>
몇분 후 api, web, db 컨테이너가 모두 실행 된 후 http://127.0.0.1:8080 에 접속하여 동작을 확인합니다.<br/>
`.env_sample`을 참고하여`.env`파일을 생성한 뒤 `docker-compose up -d` 를 실행합니다.<br/>
api, web, db 컨테이너가 모두 실행 된 후 http://127.0.0.1:8080 에 접속하여 동작을 확인합니다.<br/>
❗️주의: 컨테이너가 뜨고 패키지 설치에 시간이 걸릴수 있어서 애플리케이션 실행까지 몇분이 소요 될 수 있습니다.

<img width="352" alt="스크린샷 2023-01-02 오후 10 54 35" src="https://user-images.githubusercontent.com/24591259/210240727-139572eb-5874-4fb9-8cd5-fdbc4761cea7.png">

Expand Down Expand Up @@ -148,6 +149,8 @@ uvicorn app.main:app --port 8080
@EmojiBot --show_user --slack_id=슬랙ID
```

### 🚀 Postman 으로 유저 등록 예시
<img width="812" alt="포스트맨 등록 예시" src="https://user-images.githubusercontent.com/24591259/210569063-1c007cd0-28bd-459f-9694-90f1615f5f1f.png">
<br/>

## 🧟‍♂️ 프로세스 Live 체크 (선택)
Expand Down
2 changes: 1 addition & 1 deletion app/applications/services/user_services.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ async def get_all_users(cls) -> List[User]:

@classmethod
async def create_user(cls, attr: dict):
await cls._user_domain_service.create_user(attr)
return await cls._user_domain_service.create_user(attr)

@classmethod
async def update_user(cls, attr: dict):
Expand Down

0 comments on commit c52b44c

Please sign in to comment.