full stack fastapi template

풀스택 FastAPI 템플릿

기술 스택 및 기능

• ⚡ Python 백엔드 API용 FastAPI .
  • ? Python SQL 데이터베이스 상호 작용(ORM)용 SQLModel입니다.
  • ? FastAPI에서 데이터 검증 및 설정 관리를 위해 사용하는 Pydantic.
  • ? PostgreSQL을 SQL 데이터베이스로 사용합니다.
• 프론트엔드에 대해 반응하세요.
  • ? TypeScript, 후크, Vite 및 최신 프런트엔드 스택의 기타 부분을 사용합니다.
  • ? 프런트엔드 구성 요소에 대한 차크라 UI입니다.
  • ? 자동으로 생성된 프런트엔드 클라이언트.
  • ? 엔드투엔드 테스트를 위한 극작가입니다.
  • ? 다크 모드 지원.
• ? 개발 및 생산을 위한 Docker Compose.
• 기본적으로 보안 비밀번호 해싱.
• ? JWT(JSON 웹 토큰) 인증.
• ? 이메일 기반 비밀번호 복구.
• ✅ Pytest로 테스트합니다.
• ? 역방향 프록시/로드 밸런서로서의 Traefik.
• ? 자동 HTTPS 인증서를 처리하기 위해 프런트엔드 Traefik 프록시를 설정하는 방법을 포함하여 Docker Compose를 사용한 배포 지침입니다.
• ? GitHub Actions를 기반으로 하는 CI(지속적 통합) 및 CD(지속적 배포)입니다.

대시보드 로그인

대시보드 - 관리자

대시보드 - 사용자 생성

대시보드 - 항목

대시보드 - 사용자 설정

대시보드 - 다크 모드

대화형 API 문서

사용 방법

이 저장소를 포크하거나 복제 하여 그대로 사용할 수 있습니다.

그냥 작동합니다.

개인 저장소를 사용하는 방법

개인 저장소를 갖고 싶다면 GitHub는 포크의 가시성을 변경할 수 없기 때문에 단순히 포크하는 것을 허용하지 않습니다.

하지만 다음을 수행할 수 있습니다.

• my-full-stack 과 같은 새로운 GitHub 저장소를 생성합니다.
• 이 저장소를 수동으로 복제하고 사용하려는 프로젝트 이름으로 이름을 설정합니다(예: my-full-stack .

git clone [email protected]:fastapi/full-stack-fastapi-template.git my-full-stack

• 새 디렉터리에 입력합니다.

 cd my-full-stack

• 새 원본을 새 저장소로 설정하고 GitHub 인터페이스에서 복사합니다. 예:

git remote set-url origin [email protected]:octocat/my-full-stack.git

• 나중에 업데이트를 받을 수 있도록 이 저장소를 또 다른 "원격"으로 추가하십시오.

git remote add upstream [email protected]:fastapi/full-stack-fastapi-template.git

• 코드를 새 저장소에 푸시합니다.

git push -u origin master

원본 템플릿에서 업데이트

저장소를 복제하고 변경을 수행한 후 이 원본 템플릿에서 최신 변경 사항을 가져올 수 있습니다.

• 원본 저장소를 원격으로 추가했는지 확인하세요. 다음을 통해 확인할 수 있습니다.

git remote -v

origin    [email protected]:octocat/my-full-stack.git (fetch)
origin    [email protected]:octocat/my-full-stack.git (push)
upstream    [email protected]:fastapi/full-stack-fastapi-template.git (fetch)
upstream    [email protected]:fastapi/full-stack-fastapi-template.git (push)

• 병합하지 않고 최신 변경 사항을 가져옵니다.

git pull --no-commit upstream master

이렇게 하면 커밋하지 않고 이 템플릿의 최신 변경 사항이 다운로드되므로 커밋하기 전에 모든 것이 제대로 확인되었는지 확인할 수 있습니다.

• 충돌이 있으면 편집기에서 해결하세요.

• 완료되면 변경 사항을 커밋합니다.

git merge --continue

구성

그런 다음 .env 파일의 구성을 업데이트하여 구성을 사용자 지정할 수 있습니다.

배포하기 전에 최소한 다음 값을 변경했는지 확인하세요.

• SECRET_KEY
• FIRST_SUPERUSER_PASSWORD
• POSTGRES_PASSWORD

이를 비밀의 환경 변수로 전달할 수 있고 전달해야 합니다.

자세한 내용은 배포.md 문서를 읽어보세요.

비밀 키 생성

.env 파일의 일부 환경 변수에는 기본값이 changethis 입니다.

비밀 키를 사용하여 이를 변경해야 하며, 비밀 키를 생성하려면 다음 명령을 실행할 수 있습니다.

python -c " import secrets; print(secrets.token_urlsafe(32)) "

내용을 복사하여 비밀번호/비밀키로 사용하세요. 그리고 다시 실행하여 다른 보안 키를 생성하세요.

사용 방법 - 복사기 대체

이 저장소는 Copier를 사용하여 새 프로젝트 생성도 지원합니다.

모든 파일을 복사하고, 구성에 대한 질문을 하고, 답변으로 .env 파일을 업데이트합니다.

복사기 설치

다음을 사용하여 Copier를 설치할 수 있습니다.

pip install copier

또는 pipx 있는 경우 다음을 사용하여 실행할 수 있습니다.

pipx install copier

참고 : pipx 있는 경우 복사기 설치는 선택 사항이므로 직접 실행할 수 있습니다.

복사기로 프로젝트 생성

새 프로젝트 디렉터리의 이름을 결정하고 아래에서 사용합니다. 예를 들어 my-awesome-project 입니다.

프로젝트의 상위 디렉터리로 이동하고 프로젝트 이름으로 명령을 실행합니다.

copier copy https://github.com/fastapi/full-stack-fastapi-template my-awesome-project --trust

pipx 있고 copier 설치하지 않은 경우 직접 실행할 수 있습니다.

pipx run copier copy https://github.com/fastapi/full-stack-fastapi-template my-awesome-project --trust

.env 파일을 업데이트하는 생성 후 스크립트를 실행하려면 --trust 옵션이 필요 합니다 .

입력 변수

Copier는 프로젝트를 생성하기 전에 준비해야 할 몇 가지 데이터를 요청합니다.

하지만 걱정하지 마세요. 나중에 .env 파일에서 해당 내용을 업데이트하면 됩니다.

기본값(일부 자동 생성)을 포함한 입력 변수는 다음과 같습니다.

• project_name : (기본값: "FastAPI Project" ) API 사용자에게 표시되는 프로젝트 이름(.env)입니다.
• stack_name : (기본값: "fastapi-project" ) Docker Compose 레이블에 사용되는 스택의 이름과 프로젝트 이름(공백 없음, 마침표 없음)(.env)입니다.
• secret_key : (기본값: "changethis" ) 보안에 사용되는 프로젝트의 비밀 키는 .env에 저장되며 위의 방법으로 생성할 수 있습니다.
• first_superuser : (기본값: "[email protected]" ) 첫 번째 슈퍼유저의 이메일(.env)입니다.
• first_superuser_password : (기본값: "changethis" ) 첫 번째 슈퍼유저의 비밀번호(.env)입니다.
• smtp_host : (기본값: "") 이메일을 보낼 SMTP 서버 호스트입니다. 나중에 .env에서 설정할 수 있습니다.
• smtp_user : (기본값: "") 이메일을 보낼 SMTP 서버 사용자입니다. 나중에 .env에서 설정할 수 있습니다.
• smtp_password : (기본값: "") 이메일을 보내기 위한 SMTP 서버 비밀번호입니다. 나중에 .env에서 설정할 수 있습니다.
• emails_from_email : (기본값: "[email protected]" ) 이메일을 보낼 이메일 계정으로, 나중에 .env에서 설정할 수 있습니다.
• postgres_password : (기본값: "changethis" ) .env에 저장된 PostgreSQL 데이터베이스의 비밀번호입니다. 위의 방법으로 비밀번호를 생성할 수 있습니다.
• sentry_dsn : (기본값: "") Sentry용 DSN을 사용하는 경우 나중에 .env에서 설정할 수 있습니다.

백엔드 개발

백엔드 문서: backend/README.md.

프론트엔드 개발

프론트엔드 문서: frontend/README.md.

전개

배포 문서: 배포.md.

개발

일반 개발 문서: development.md.

여기에는 Docker Compose, 사용자 지정 로컬 도메인, .env 구성 등의 사용이 포함됩니다.

릴리스 노트

release-notes.md 파일을 확인하세요.

특허

전체 스택 FastAPI 템플릿은 MIT 라이선스 조건에 따라 라이선스가 부여됩니다.