FastAPI Template

Fastapi 템플릿

설명

FastApi 템플릿은 FastApi 응용 프로그램을 구축하기위한 좋은 파일 구조와 설정을 제공하는 프로젝트 템플릿입니다. 사전 구성된 개발 환경, 프로덕션 준비된 배포 스크립트 및 SSL 구성 옵션이 포함됩니다. 이 템플릿은 개발자가 강력한 기초와 모범 사례를 염두에두고 새로운 Fastapi 프로젝트를보다 쉽게 ​​시작할 수 있도록하는 것을 목표로합니다.

특징

• FastApi 응용 프로그램을 구성하기 위해 파일 구조를 깨끗하게하십시오
• 고립 된 종속성을위한 가상 환경 설정
• 배포를위한 프로덕션 준비된 배쉬 스크립트
• 보안 연결을위한 구성 가능한 SSL 설정
• 로그가 파일에 저장된 사전 구성된 로깅
• 많은 옵션으로 로그를보고 검색하기위한 웹 UI

설치

1. 저장소 복제 :

git clone https://github.com/Neko-Nik/FastAPI-Template.git
cd FastAPI-Template

2. 가상 환경을 만들고 활성화하십시오.

python3 -m venv virtualenv
source virtualenv/bin/activate

3. 필요한 종속성 설치 :

pip3 install -r requirements.txt

용법

Uvicorn 또는 Gunicorn을 사용하여 로컬로 응용 프로그램을 실행하려면 :

Uvicorn 사용 : uvicorn api.main:app --reload --port 8086

Gunicorn 사용 : gunicorn -k uvicorn.workers.UvicornWorker api.main:app

응용 프로그램은 http : // localhost : 8086에서 실행됩니다.

전개

생산 배포의 경우 템플릿은 Docker CI 파이프 라인 및 docker-compose Configuration 파일을 쉽게 배포 할 수 있도록 제공합니다.

기여

기부금을 환영합니다! Fastapi 템플릿에 기여하려면 다음을 수행하십시오.

1. 저장소를 포크하십시오
2. 기능 또는 버그 수정에 대한 새 지점 만들기
3. 당신의 변화를 만들고 그들을 커밋하십시오
4. 변경 사항을 포크로 밀어 넣으십시오
5. 원래 저장소의 master 브랜치에 풀 요청을 제출하십시오.

기존 코드 스타일을 따르고 새로운 기능이나 버그 수정에 대한 테스트를 추가하십시오.

특허

Fastapi 템플릿은 MIT 라이센스에 따라 릴리스됩니다. 이 템플릿을 어떤 목적 으로든 자유롭게 사용, 수정 및 배포 할 수 있습니다.