FastAPI Template

Plantilla de Fastapi

Descripción

La plantilla Fastapi es una plantilla de proyecto que proporciona una buena estructura de archivos y una configuración para construir aplicaciones Fastapi. Incluye un entorno de desarrollo preconfigurado, scripts de implementación listos para la producción y opciones de configuración SSL. Esta plantilla tiene como objetivo facilitar que los desarrolladores inicien nuevos proyectos de Fastapi con una base sólida y las mejores prácticas en mente.

Características

• Estructura de archivo limpio para organizar su aplicación Fastapi
• Configuración del entorno virtual para dependencias aisladas
• Scripts bash listos para la producción para el despliegue
• Configuración de SSL configurable para conexiones seguras
• Registro preconfigurado con registros guardados en un archivo
• UI web para ver y buscar registros con muchas opciones

Instalación

1. Clon el repositorio:

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

2. Crear un entorno virtual y activarlo:

python3 -m venv virtualenv
source virtualenv/bin/activate

3. Instale las dependencias requeridas:

pip3 install -r requirements.txt

Uso

Para ejecutar la aplicación localmente, usando Uvicorn o Gunicorn:

Uso de Uvicorn: uvicorn api.main:app --reload --port 8086

Uso de Gunicorn: gunicorn -k uvicorn.workers.UvicornWorker api.main:app

La aplicación comenzará a ejecutarse en http: // localhost: 8086.

Despliegue

Para la implementación de producción, la plantilla proporciona archivos Docker CI CI y archivos de configuración docker-compose para una fácil implementación.

Que contribuye

¡Las contribuciones son bienvenidas! Si desea contribuir a la plantilla Fastapi, siga estos pasos:

1. Bifurca el repositorio
2. Cree una nueva rama para su función o corrección de errores
3. Haga sus cambios y compromételos
4. Empuja tus cambios a tu bifurcación
5. Envíe una solicitud de extracción a la rama master del repositorio original

Asegúrese de seguir el estilo de código existente y agregar pruebas para cualquier característica nueva o corrección de errores.

Licencia

La plantilla de Fastapi se libera bajo la licencia MIT. Usted es libre de usar, modificar y distribuir esta plantilla para cualquier propósito.