full stack fastapi mongodb

Fulapi de pilha completa, React, MongoDB (Farm) Gerador de Projeto Base

Mostre seu amor por este projeto estrelando nosso repositório?, Para que possamos continuar inovando?

Acelere seu próximo projeto de desenvolvimento da web com este gerador de projeto de base FASTAPI/React/MongoDB.

Este projeto é para desenvolvedores que desejam construir e manter aplicativos progressivos completos da Web usando o Python no back-end / datilografado no front-end e desejam os aspectos complexos, mas rotineiros de autentidura, e a configuração de componente e implantação, cuidados, incluindo documentação interativa da API.

Este é um garfo experimental do gerador de projeto de base completo de Sebastián Ramírez e Gerador de Projeto Base PostgreSQL e o gerador de projetos de Base Flash Fastapi e PostgreSQL da WhyThawk. O FASTAPI é atualizado para a versão 0.103.2, MongoDB Motor 3.4, Odmantic ODM 1.0.0 e o front -end para reagir.

Índice

• Requisitos
• Investir rápido
• Capturas de tela
• Principais recursos
• Como usá -lo
  • Construindo um aplicativo gerado
  • Desenvolvimento e instalação
  • Implantação para produção
  • Autenticação e tokens de magia
  • Websockets para comunicação interativa
• Mais detalhes
• Ajuda necessária
• Notas de liberação
• Licença

Requisitos

Certifique -se de que você tenha instalado antes de prosseguir!

• Docker Desktop
• Python 3.11+
• Cookiecutter - a biblioteca Python Cookiecutter.
• Chocar
• Node.js
• MongoDB Compass - Para ajudar a visualizar o banco de dados local/remoto facilmente.

Investir rápido

Observe que isso gerará um aplicativo local que ainda não está pronto para produção. Por favor, analise todas as informações do ReadMe vinculadas antes de criar uma versão para implantar para um host de produção

Para aqueles que desejam mergulhar e brincar com o código gerado, aqui está um guia de início rápido sobre como fazê -lo. É aconselhado, no entanto, depois que você executa a geração deste aplicativo pela primeira vez, que você circule e confira a criação mais desenvolvida de uma seção de aplicativo gerado.

 // Make sure cookiecutter and python are installed on the device
// This will generate a full-stack app in the directory ./example
cookiecutter https://github.com/mongodb-labs/full-stack-fastapi-mongodb --no-input project_name="example"

// Move into that directory.
cd example

// Make sure that you've opened the Docker Desktop app before this step.
// build
docker compose build --no-cache

// start the container in the background
docker compose up -d 

Agora você pode visualizar o site indo para localhost:3000 . Você também pode ver todos os logs dos contêineres em execução no seu aplicativo Docker Desktop.

Haverá apenas um usuário no site: [email protected] . Se você escolher um nome de projeto diferente, o domínio de email muda. Por exemplo, se você criar seu projeto usando project_name=fullstackexample o e -mail do usuário será [email protected] . A senha padrão será definida como changethis mas isso pode ser alterado.

Aqui estão todos os URLs de desenvolvimento local:

• Frontend - http: // localhost: 3000
• Back -end - http: // localhost/api/v1/
• Documentação automática via Swagger UI - http: // localhost/docs
• Documentação alternativa via Redoc - http: // localhost/redoc
• Flor: Ferramenta de Administração de Tarefas de Aipo - http: // localhost: 5555
• TRAEFIK UI para ver como as rotas estão sendo tratadas pelo proxy: http: // localhost: 8090

Consulte a criação de um aplicativo gerado para exemplos de como são essas páginas.

Principais recursos

Este repositório FASTAPI, REACT e MONGODB gerará uma pilha de aplicativos da Web completa como base para o desenvolvimento do seu projeto.

• Docker compõe integração e otimização para o desenvolvimento local.
• Esquemas de gerenciamento de usuários de autenticação , modelos, CRUD e APIs já construídos, com suporte e hash de token JWT OAuth2 JWT. Oferece autenticação de Link Magic , com fallback de senha, com gerenciamento de cookies, incluindo tokens access e refresh .
• FASTAPI Backend com imagens de Docker de um reprovação interna:
  • MONGODB MOTOR https://motor.readthedocs.io/en/stable/
  • MongoDB Odmantic para lidar com a criação de ODM https://art049.github.io/odmantic/
  • Suporte comum do CRUD via herança genérica.
  • Baseado em padrões : com base em (e totalmente compatível com) os padrões abertos para APIs: OpenAPI e JSON Schema.
  • Muitos outros recursos : incluindo validação automática, serialização, documentação interativa, etc.
• Frontend NextJs/React :
  • Autenticação baseada em rota de autorização , incluindo suporte para detecção se um usuário estiver conectado ou for um superusuário.
  • Validação do formulário com react useform
  • Gerenciamento de Estado com Redux
  • CSS e modelos com Tailwindcss, Heroicons e Headlessui.
• Trabalhador de aipo que pode importar e usar modelos e codificar do restante do back -end seletivamente.
• Flor para monitoramento de empregos em aipo.
• O balanceamento de carga entre o front -end e o back -end com o Traefik , para que você possa ter os dois no mesmo domínio, separados pelo caminho, mas servidos por diferentes recipientes.
• Integração Traefik, incluindo os certificados Let's Crypty HTTPS Generation.
• Gitlab CI (integração contínua), incluindo testes de front -end e back -end.

Como usar o modelo

• Construindo um aplicativo gerado
• Desenvolvimento e instalação
• Implantação para produção
• Autenticação e tokens de magia
• Websockets para comunicação interativa

Mais detalhes

Depois de usar este gerador, seu novo projeto (o diretório criado) conterá um extenso README.md com instruções para desenvolvimento, implantação, etc. Você também pode ler o modelo README.md do projeto.

Esta versão atual é para a versão FASTAPI 0.103 e apresenta suporte para Pydantic 2. Como isso se destina a uma pilha base na qual você criará aplicativos complexos, não há intenção de compatibilidade com versões anteriores entre as versões, e o objetivo é garantir que cada liberação tenha o seu mais recente núcleo de longa data das bibliotecas principais.

Para se alinhar com a interior, a poesia foi presa em favor da escotilha. Esperançosamente, isso também resolverá alguns erros de construção do Docker relacionados à poesia.

Ajuda necessária

Atualmente, este projeto é experimental, para que bugs ou problemas possam ocorrer. Por favor, abra um ingresso em questão contra este repositório para nos conscientizar sobre os problemas e faremos o possível para responder a eles em tempo hábil. Deixe o feedback sobre os recursos que seriam muito benéficos para os desenvolvedores que frequentemente aproveitam o MongoDB em sua pilha FASTAPI.

Notas de liberação

Nota: Não há intenção de ter compatibilidade com versões anteriores entre as liberações.

Veja Notas:

Calver 2024.01.10

• Uso do gorro substituído por Odmantic
• Fixado o login do TOTP
• Autenticação de rota no nível da página adicionada
• Corrigido emitido com o usuário conectado ao usuário não conseguir acessar /settings da página
• Lançar erros em cada resposta não OK Auth.ts
• Pojeito fixo denominado geração em rodapé.tsx
• Rotas de cors não utilizadas removidas
• Readme atualizado
  • Adicionado QuickStart
  • Requisitos adicionados
  • Informações de URL de contêiner adicionadas
• Documentos atualizados/
  • Docker_example colocado
  • REFERÊNCIAS DE NUXT E REFERÊNCIAS E REFERÊNCIAS DE
  • Indexação atualizada

Calver 2023.11.10

• Estrutura de front -end substituída Next/Vue.js com reagir/redux inteiramente
• Conexão nativa de back -end substituída de PostgreSQL/SqlalChemy com MongoDB Motor/Beanie ODM
• Plugin Neo4J removido
• Removido o uso Alembic
• Introduziu novas variáveis de ambiente de cookiecutter mongodb_uri e mongo_database
• Apoio introduzido para Pydantic 2

Mudanças históricas de WhyThewk Historic Mudanças do original

Licença

Este projeto está licenciado nos termos da licença do MIT.