https://github.com/miintto/matstagram

지도에서 나만의 맛집을 추가하고 관리하자!
https://github.com/miintto/matstagram

fastapi python sqlalchemy uvicorn

Last synced: about 1 month ago
JSON representation

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

Host: GitHub
URL: https://github.com/miintto/matstagram
Owner: miintto
Created: 2022-11-06T12:15:57.000Z (over 3 years ago)
Default Branch: master
Last Pushed: 2024-03-24T03:40:48.000Z (over 2 years ago)
Last Synced: 2025-03-24T07:55:43.338Z (over 1 year ago)
Topics: fastapi, python, sqlalchemy, uvicorn
Language: Python
Homepage:
Size: 265 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# 맛스타그램

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

### 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

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

# == Dot Env Files == #

# - FASTAPI SECRET
APP_ENV=local
...
```

## 1.2 Install Libraries

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

## 1.3 Run Uvicorn Server

```bash
(.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

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

# 2. Test

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

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

테스트 실행

```bash
(.venv) $> pytest
```

# 3. Demo

## 3.1 메인 진입 화면

matstagram_main