Este es un proyecto MVP de un chatbot en español de para responder preguntas frecuentes de pequeñas empresas. Está dividido en backend (IA y API) y frontend (widget web).
chatbot-faq-mvp/ ├── backend/ # API en FastAPI + OpenAI + FAISS ├── frontend/ # Widget embebible en HTML + JS ├── .env.example # Plantilla de variables de entorno
- Crea un entorno virtual (recomendado):
python -m venv chatbot
source chatbot/bin/activate # En Windows: chatbot\Scripts\activate
2. Instala las dependencias:
pip install -r requirements.txt
3. Crea un archivo .env basado en el ejemplo:
cp .env.example .env
4. Abre .env y añade tu API Key de OpenAI:
OPENAI_API_KEY=tu_clave_de_openai_aqui
5. Ejecuta el servidor:
uvicorn backend.main:app --reload
La API estará disponible en: http://localhost:8000
⸻
Frontend
1. Abre la carpeta frontend.
2. Abre index.html directamente en el navegador o usa Live Server en VS Code.
⸻
🔄 Cómo actualizar tu copia local cuando tu compañero sube cambios
1. Abre la terminal integrada de VS Code (Terminal → New Terminal).
2. Navega a la carpeta del proyecto si no estás allí:
cd ruta/a/chatbot-faq-mvp
3. Asegúrate de estar en la rama principal:
git checkout main
4. Descarga los últimos cambios desde GitHub:
git pull origin main
5. ¡Listo! Revisa los nuevos archivos en Visual Studio Code.
⸻
👥 Recomendaciones para trabajar en equipo
• Usar ramas para cada funcionalidad: git checkout -b nombre-rama
• Hacer commits claros: git commit -m "feat: añadir saludo inicial del bot"
• Subir cambios con: git push origin nombre-rama
• Crear pull requests en GitHub para revisar y fusionar a main
• Hacer git pull antes de empezar a trabajar para evitar conflictos
• Usar Issues para organizar tareas
⸻