Skip to content

Latest commit

 

History

History
116 lines (75 loc) · 2.96 KB

README.md

File metadata and controls

116 lines (75 loc) · 2.96 KB

맛스타그램

지도에서 나만의 맛집을 추가하고 관리하자!

Environments

  • OS:
    • Mac on M1 (local)
    • Amazon Linux 2 AMI (production)
  • Languages:
    • Python 3.10
    • Javascript
  • Libraries
    • FastAPI 0.85.1
    • Uvicorn 0.19.0
    • JQuery 3.6.1
  • Database:
    • PostgreSQL 12.7

1. Quick Start

1.1 Set Environment Variables

$> cp .env.example .env.local
$> vim .env.local

# == Dot Env Files == #

# - FASTAPI SECRET
APP_ENV=local
...

1.2 Install Libraries

$> virtualenv -p python3.10 .venv
$> source .venv/bin/activate
(.venv) $> poetry install

1.3 Run Uvicorn Server

(.venv) $> uvicorn app.main:app
APP_ENV:  local
INFO:     Started server process [45145]
INFO:     Waiting for application startup.
INFO:     Application startup complete.
INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)

1.4 Run Server Using Docker

(.venv) $> docker-compose --env-file .env.local up -d

2. Test

테스트시 local 환경에 별도 DB를 기준으로 진행하도록 하였습니다. docker 환경으로 postgreSQL을 실행합니다.

(.venv) $> docker-compose -f ./tests/docker-compose.test.yml up -d
Pulling postgres (postgres:12.7)...

테스트 실행

(.venv) $> pytest

3. Demo

3.1 메인 진입 화면

matstagram_main

3.2 회원 가입

matstagram_register

3.3 맛집 화면

3.3.1 내가 등록한 맛집 표시

matstagram_map

3.3.2 특정 장소 클릭시

matstagram_map_click

3.3.3 원하는 태그로 필터링

matstagram_filter

3.4 내가 등록한 맛집 리스팅

matstagram_list

3.5 내 정보

3.5.1 프로필 화면

matstagram_profile

3.5.2 프로필 수정

matstagram_profile_update

3.6 API 문서 화면

matstagram_documents