cheems-dev / fastapi-openai

Este proyecto utiliza FastAPI, la API de OpenAI y MongoDB Atlas para crear una aplicación web.

Proyecto FastAPI + OpenAI + MongoDB Atlas

Este proyecto utiliza FastAPI, la API de OpenAI y MongoDB Atlas para crear una aplicación web. Aquí encontrarás instrucciones para ejecutar el proyecto en local y detalles sobre su implementación en un servidor.

Contenido

1. Descripción del Proyecto
2. Requisitos
3. Configuración del Entorno Local
   1. Clonar el Repositorio
   2. Configurar Variables de Entorno
   3. Instalar Dependencias
   4. Ejecutar la Aplicación
4. Aplicación en Producción
5. Documentación de la API

Descripción del Proyecto

Este proyecto fue desarrollado utilizando FastAPI para el backend, OpenAI para funcionalidades de inteligencia artificial y MongoDB Atlas para la base de datos.

Requisitos

• Python 3.8 o superior
• Acceso a internet para instalar dependencias y conectar con MongoDB Atlas
• Cuenta en MongoDB Atlas y en OpenAI para obtener las claves de API correspondientes

Configuración del Entorno Local

Clonar el Repositorio

Primero, clona el repositorio a tu máquina local:

git clone https://github.com/tu-usuario/tu-repositorio.git
cd tu-repositorio

Abre el archivo .env y completa las siguientes variables:

OPENAI_API_KEY=tu_clave_de_openai
MONGODB_URI=tu_uri_de_mongodb_atlas

Instalar Dependencias

Instala las dependencias necesarias usando pip:

pip install -r requirements.txt

Ejecutar la Aplicación

Finalmente, ejecuta la aplicación.

uvicorn main:app --reload

La aplicación debería estar corriendo en http://127.0.0.1:8000.

Aplicación en Producción

El proyecto está actualmente desplegado en Render. Puedes acceder a la aplicación en producción a través del siguiente enlace: https://fastapi-openai.onrender.com/docs

Documentación de la API

FastAPI genera documentación interactiva automáticamente. Puedes acceder a la documentación de la API en:

• /docs para Swagger UI

Para la versión en producción, visita https://fastapi-openai.onrender.com/docs.