full stack fastapi template

Modelo Full Stack FastAPI

Pilha de tecnologia e recursos

• ⚡ FastAPI para API de back-end Python.
  • ? SQLModel para as interações de banco de dados SQL (ORM) do Python.
  • ? Pydantic, utilizado pela FastAPI, para validação de dados e gerenciamento de configurações.
  • ? PostgreSQL como banco de dados SQL.
• Reaja para o frontend.
  • ? Usando TypeScript, hooks, Vite e outras partes de uma pilha de front-end moderna.
  • ? Chakra UI para os componentes frontend.
  • ? Um cliente front-end gerado automaticamente.
  • ? Dramaturgo para testes de ponta a ponta.
  • ? Suporte ao modo escuro.
• ? Docker Compose para desenvolvimento e produção.
• Hash de senha seguro por padrão.
• ? Autenticação JWT (JSON Web Token).
• ? Recuperação de senha baseada em e-mail.
• ✅ Testes com Pytest.
• ? Traefik como proxy reverso/balanceador de carga.
• ? Instruções de implantação usando Docker Compose, incluindo como configurar um proxy Traefik frontend para lidar com certificados HTTPS automáticos.
• ? CI (integração contínua) e CD (implantação contínua) baseados em GitHub Actions.

Login no painel

Painel - Administrador

Painel - Criar usuário

Painel - Itens

Painel - Configurações do usuário

Painel - Modo escuro

Documentação interativa da API

Como usá-lo

Você pode simplesmente bifurcar ou clonar este repositório e usá-lo como está.

Simplesmente funciona.

Como usar um repositório privado

Se você deseja ter um repositório privado, o GitHub não permitirá que você simplesmente faça um fork, pois não permite alterar a visibilidade dos forks.

Mas você pode fazer o seguinte:

• Crie um novo repositório GitHub, por exemplo my-full-stack .
• Clone este repositório manualmente, defina o nome com o nome do projeto que deseja usar, por exemplo my-full-stack :

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

• Entre no novo diretório:

 cd my-full-stack

• Defina a nova origem para o seu novo repositório, copie-o da interface do GitHub, por exemplo:

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

• Adicione este repositório como outro "remoto" para permitir que você receba atualizações mais tarde:

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

• Envie o código para seu novo repositório:

git push -u origin master

Atualizar do modelo original

Depois de clonar o repositório e fazer alterações, você pode querer obter as alterações mais recentes deste modelo original.

• Certifique-se de adicionar o repositório original como remoto, você pode verificar isso com:

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)

• Obtenha as alterações mais recentes sem mesclar:

git pull --no-commit upstream master

Isso fará o download das alterações mais recentes deste modelo sem confirmá-las, dessa forma você poderá verificar se está tudo certo antes de enviar.

• Se houver conflitos, resolva-os no seu editor.

• Quando terminar, confirme as alterações:

git merge --continue

Configurar

Você pode então atualizar as configurações nos arquivos .env para personalizar suas configurações.

Antes de implantá-lo, certifique-se de alterar pelo menos os valores de:

• SECRET_KEY
• FIRST_SUPERUSER_PASSWORD
• POSTGRES_PASSWORD

Você pode (e deve) passá-las como variáveis ​​de ambiente de segredos.

Leia a documentação do deploy.md para obter mais detalhes.

Gerar chaves secretas

Algumas variáveis ​​de ambiente no arquivo .env têm um valor padrão changethis .

Você tem que alterá-los com uma chave secreta, para gerar chaves secretas você pode executar o seguinte comando:

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

Copie o conteúdo e use-o como senha/chave secreta. E execute novamente para gerar outra chave segura.

Como usar – alternativa com copiadora

Este repositório também suporta a geração de um novo projeto usando o Copier.

Ele copiará todos os arquivos, fará perguntas de configuração e atualizará os arquivos .env com suas respostas.

Instalar copiadora

Você pode instalar a Copiadora com:

pip install copier

Ou melhor, se você tiver pipx , poderá executá-lo com:

pipx install copier

Nota : Se você tiver pipx , a instalação da copiadora é opcional, você pode executá-la diretamente.

Gerar um projeto com copiadora

Decida um nome para o diretório do seu novo projeto, você o usará abaixo. Por exemplo, my-awesome-project .

Vá até o diretório que será o pai do seu projeto e execute o comando com o nome do seu projeto:

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

Se você possui pipx e não instalou copier , você pode executá-lo diretamente:

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

Observe que a opção --trust é necessária para poder executar um script pós-criação que atualize seus arquivos .env .

Variáveis ​​de entrada

A copiadora solicitará alguns dados que você pode querer ter em mãos antes de gerar o projeto.

Mas não se preocupe, você pode simplesmente atualizar tudo isso nos arquivos .env posteriormente.

As variáveis ​​de entrada, com seus valores padrão (alguns gerados automaticamente) são:

• project_name : (padrão: "FastAPI Project" ) O nome do projeto, mostrado aos usuários da API (em .env).
• stack_name : (padrão: "fastapi-project" ) O nome da pilha usada para rótulos Docker Compose e nome do projeto (sem espaços, sem pontos) (em .env).
• secret_key : (padrão: "changethis" ) A chave secreta do projeto, usada para segurança, armazenada em .env, você pode gerar uma com o método acima.
• first_superuser : (padrão: "[email protected]" ) O e-mail do primeiro superusuário (em .env).
• first_superuser_password : (padrão: "changethis" ) A senha do primeiro superusuário (em .env).
• smtp_host : (padrão: "") O host do servidor SMTP para enviar e-mails, você pode configurá-lo posteriormente em .env.
• smtp_user : (padrão: "") O usuário do servidor SMTP para enviar e-mails, você pode configurá-lo posteriormente em .env.
• smtp_password : (padrão: "") A senha do servidor SMTP para enviar e-mails, você pode defini-la posteriormente em .env.
• emails_from_email : (padrão: "[email protected]" ) A conta de e-mail para enviar e-mails, você pode configurá-la posteriormente em .env.
• postgres_password : (padrão: "changethis" ) A senha do banco de dados PostgreSQL, armazenada em .env, você pode gerar uma com o método acima.
• sentry_dsn : (padrão: "") O DSN do Sentry, se você estiver usando, poderá configurá-lo posteriormente em .env.

Desenvolvimento de back-end

Documentos de back-end: backend/README.md.

Desenvolvimento front-end

Documentos de front-end: frontend/README.md.

Implantação

Documentos de implantação: implantação.md.

Desenvolvimento

Documentos gerais de desenvolvimento: development.md.

Isso inclui o uso do Docker Compose, domínios locais personalizados, configurações .env , etc.

Notas de versão

Verifique o arquivo release-notes.md.

Licença

O modelo Full Stack FastAPI é licenciado sob os termos da licença MIT.