full stack fastapi template

Plantilla FastAPI de pila completa

Pila de tecnología y características

• ⚡ FastAPI para la API backend de Python.
  • ? SQLModel para las interacciones de la base de datos Python SQL (ORM).
  • ? Pydantic, utilizado por FastAPI, para la validación de datos y gestión de configuraciones.
  • ? PostgreSQL como base de datos SQL.
• Reaccionar para la interfaz.
  • ? Usando TypeScript, ganchos, Vite y otras partes de una pila de interfaz moderna.
  • ? UI de Chakra para los componentes del frontend.
  • ? Un cliente frontend generado automáticamente.
  • ? Dramaturgo para pruebas de extremo a extremo.
  • ? Soporte de modo oscuro.
• ? Docker Compose para desarrollo y producción.
• Hash de contraseña seguro de forma predeterminada.
• ? Autenticación JWT (JSON Web Token).
• ? Recuperación de contraseña basada en correo electrónico.
• ✅Pruebas con Pytest.
• ? Traefik como proxy inverso/equilibrador de carga.
• ? Instrucciones de implementación utilizando Docker Compose, incluido cómo configurar un proxy Traefik frontal para manejar certificados HTTPS automáticos.
• ? CI (integración continua) y CD (implementación continua) basados ​​en GitHub Actions.

Iniciar sesión en el panel

Panel de control - Administrador

Panel de control: crear usuario

Panel de control - Artículos

Panel de control: configuración de usuario

Panel de control: modo oscuro

Documentación API interactiva

Cómo usarlo

Puedes simplemente bifurcar o clonar este repositorio y usarlo tal como está.

Simplemente funciona.

Cómo utilizar un repositorio privado

Si desea tener un repositorio privado, GitHub no le permitirá simplemente bifurcarlo ya que no permite cambiar la visibilidad de las bifurcaciones.

Pero puedes hacer lo siguiente:

• Cree un nuevo repositorio de GitHub, por ejemplo my-full-stack .
• Clona este repositorio manualmente, configura el nombre con el nombre del proyecto que deseas usar, por ejemplo my-full-stack :

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

• Ingrese al nuevo directorio:

 cd my-full-stack

• Establece el nuevo origen en tu nuevo repositorio, cópialo desde la interfaz de GitHub, por ejemplo:

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

• Agregue este repositorio como otro "remoto" para permitirle obtener actualizaciones más tarde:

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

• Envíe el código a su nuevo repositorio:

git push -u origin master

Actualización desde la plantilla original

Después de clonar el repositorio y después de realizar cambios, es posible que desee obtener los últimos cambios de esta plantilla original.

• Asegúrate de haber agregado el repositorio original como remoto, puedes verificarlo con:

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)

• Extraiga los últimos cambios sin fusionarlos:

git pull --no-commit upstream master

Esto descargará los últimos cambios de esta plantilla sin confirmarlos, de esa manera podrá verificar que todo esté bien antes de confirmarlos.

• Si hay conflictos, resuélvelos en tu editor.

• Una vez que haya terminado, confirme los cambios:

git merge --continue

Configurar

Luego puede actualizar las configuraciones en los archivos .env para personalizar sus configuraciones.

Antes de implementarlo, asegúrese de cambiar al menos los valores de:

• SECRET_KEY
• FIRST_SUPERUSER_PASSWORD
• POSTGRES_PASSWORD

Puede (y debe) pasarlos como variables de entorno de secretos.

Lea los documentos de implementación.md para obtener más detalles.

Generar claves secretas

Algunas variables de entorno en el archivo .env tienen un valor predeterminado de changethis .

Tienes que cambiarlas con una clave secreta, para generar claves secretas puedes ejecutar el siguiente comando:

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

Copie el contenido y utilícelo como contraseña/clave secreta. Y ejecútelo nuevamente para generar otra clave segura.

Cómo usarlo: alternativa con fotocopiadora

Este repositorio también admite la generación de un nuevo proyecto utilizando Copier.

Copiará todos los archivos, le hará preguntas de configuración y actualizará los archivos .env con sus respuestas.

Instalar copiadora

Puede instalar Copiadora con:

pip install copier

O mejor, si tienes pipx , puedes ejecutarlo con:

pipx install copier

Nota : Si tiene pipx , la instalación de la copiadora es opcional, puede ejecutarla directamente.

Generar un proyecto con fotocopiadora

Decida un nombre para el directorio de su nuevo proyecto, lo usará a continuación. Por ejemplo, my-awesome-project .

Vaya al directorio que será el padre de su proyecto y ejecute el comando con el nombre de su proyecto:

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

Si tiene pipx y no instaló copier , puede ejecutarlo directamente:

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

Tenga en cuenta que la opción --trust es necesaria para poder ejecutar un script posterior a la creación que actualice sus archivos .env .

Variables de entrada

La fotocopiadora le pedirá algunos datos que quizás desee tener a mano antes de generar el proyecto.

Pero no te preocupes, puedes actualizar todo eso en los archivos .env después.

Las variables de entrada, con sus valores predeterminados (algunos generados automáticamente) son:

• project_name : (predeterminado: "FastAPI Project" ) El nombre del proyecto, que se muestra a los usuarios de API (en .env).
• stack_name : (predeterminado: "fastapi-project" ) El nombre de la pila utilizada para las etiquetas de Docker Compose y el nombre del proyecto (sin espacios ni puntos) (en .env).
• secret_key : (predeterminado: "changethis" ) La clave secreta para el proyecto, utilizada por seguridad, almacenada en .env; puede generar una con el método anterior.
• first_superuser : (predeterminado: "[email protected]" ) El correo electrónico del primer superusuario (en .env).
• first_superuser_password : (predeterminado: "changethis" ) La contraseña del primer superusuario (en .env).
• smtp_host : (predeterminado: "") El servidor SMTP host para enviar correos electrónicos, puede configurarlo más adelante en .env.
• smtp_user : (predeterminado: "") El usuario del servidor SMTP para enviar correos electrónicos, puede configurarlo más tarde en .env.
• smtp_password : (predeterminado: "") La contraseña del servidor SMTP para enviar correos electrónicos, puede configurarla más tarde en .env.
• emails_from_email : (predeterminado: "[email protected]" ) La cuenta de correo electrónico desde la que enviar correos electrónicos, puede configurarla más adelante en .env.
• postgres_password : (predeterminado: "changethis" ) La contraseña para la base de datos PostgreSQL, almacenada en .env, puede generar una con el método anterior.
• sentry_dsn : (predeterminado: "") El DSN para Sentry, si lo está utilizando, puede configurarlo más tarde en .env.

Desarrollo de back-end

Documentos de backend: backend/README.md.

Desarrollo front-end

Documentos de interfaz: frontend/README.md.

Despliegue

Documentos de implementación: implementación.md.

Desarrollo

Documentos generales de desarrollo: development.md.

Esto incluye el uso de Docker Compose, dominios locales personalizados, configuraciones .env , etc.

Notas de la versión

Verifique el archivo release-notes.md.

Licencia

La plantilla Full Stack FastAPI tiene licencia según los términos de la licencia MIT.