Docs: Add professional README and update .env.example
This commit is contained in:
@@ -0,0 +1,10 @@
|
||||
# Firebase Configuration
|
||||
VITE_FIREBASE_API_KEY=your_api_key_here
|
||||
VITE_FIREBASE_AUTH_DOMAIN=your_project_id.firebaseapp.com
|
||||
VITE_FIREBASE_PROJECT_ID=your_project_id
|
||||
VITE_FIREBASE_STORAGE_BUCKET=your_project_id.appspot.com
|
||||
VITE_FIREBASE_MESSAGING_SENDER_ID=your_sender_id
|
||||
VITE_FIREBASE_APP_ID=your_app_id
|
||||
|
||||
# n8n Webhook Configuration
|
||||
VITE_WEBHOOK_URL=https://your-n8n-instance.com/webhook/path
|
||||
@@ -1,20 +1,56 @@
|
||||
<div align="center">
|
||||
<img width="1200" height="475" alt="GHBanner" src="https://github.com/user-attachments/assets/0aa67016-6eaf-458a-adb2-6e31a0763ed6" />
|
||||
</div>
|
||||
# Portal Brief Inteligente CDC
|
||||
|
||||
# Run and deploy your AI Studio app
|
||||
Sistema generador de briefs inteligentes basado en IA para el análisis de activos multimedia y documentos.
|
||||
|
||||
This contains everything you need to run your app locally.
|
||||
## Descripción
|
||||
Este proyecto es una interfaz frontend moderna y profesional diseñada para automatizar la creación de briefs. El sistema guía al usuario a través de un proceso estructurado que incluye la carga de notas de voz, imágenes de referencia, documentos técnicos y enlaces externos.
|
||||
|
||||
View your app in AI Studio: https://ai.studio/apps/d6393390-53fa-4d74-b914-e4fff219462b
|
||||
Utiliza un flujo de trabajo de **n8n** en el backend para procesar el audio (transcripción y análisis), analizar imágenes y consolidar toda la información en un brief estructurado en cuestión de segundos.
|
||||
|
||||
## Run Locally
|
||||
## Características Principales
|
||||
- **Análisis de Audio**: Transcripción y extracción de puntos clave mediante IA.
|
||||
- **Análisis de Imágenes**: Procesamiento visual para referencias de diseño.
|
||||
- **Gestión de Documentos**: Soporte para PDF, Excel, PowerPoint y Word.
|
||||
- **Flujo Guiado**: Interfaz por pasos para garantizar la calidad de la información.
|
||||
- **Autenticación Corporativa**: Acceso restringido vía Google Auth para dominios autorizados.
|
||||
|
||||
**Prerequisites:** Node.js
|
||||
## Requisitos
|
||||
- Node.js (v18 o superior recomendado)
|
||||
- npm o yarn
|
||||
- Instancia de n8n con el workflow de procesamiento de briefs configurado
|
||||
- Proyecto en Firebase para la autenticación
|
||||
|
||||
## Cómo instalar
|
||||
1. Clonar el repositorio.
|
||||
2. Ejecutar la instalación de dependencias:
|
||||
```bash
|
||||
npm install
|
||||
```
|
||||
|
||||
1. Install dependencies:
|
||||
`npm install`
|
||||
2. Set the `GEMINI_API_KEY` in [.env.local](.env.local) to your Gemini API key
|
||||
3. Run the app:
|
||||
`npm run dev`
|
||||
## Cómo correr en local
|
||||
1. Asegúrate de tener el archivo `.env` configurado (puedes basarte en `.env.example`).
|
||||
2. Inicia el servidor de desarrollo:
|
||||
```bash
|
||||
npm run dev
|
||||
```
|
||||
3. Abre [http://localhost:3000](http://localhost:3000) en tu navegador.
|
||||
|
||||
## Cómo generar build
|
||||
Para generar la versión de producción:
|
||||
```bash
|
||||
npm run build
|
||||
```
|
||||
Los archivos optimizados se generarán en la carpeta `dist/`.
|
||||
|
||||
## Variables de Entorno Requeridas
|
||||
El proyecto requiere las siguientes variables en un archivo `.env`:
|
||||
- `VITE_FIREBASE_API_KEY`: API Key de Firebase.
|
||||
- `VITE_FIREBASE_AUTH_DOMAIN`: Dominio de autenticación.
|
||||
- `VITE_FIREBASE_PROJECT_ID`: ID del proyecto Firebase.
|
||||
- `VITE_FIREBASE_STORAGE_BUCKET`: Bucket de almacenamiento.
|
||||
- `VITE_FIREBASE_MESSAGING_SENDER_ID`: ID del remitente de mensajería.
|
||||
- `VITE_FIREBASE_APP_ID`: ID de la aplicación Firebase.
|
||||
- `VITE_WEBHOOK_URL`: URL del webhook de n8n para procesar el brief.
|
||||
|
||||
## Nota de Seguridad
|
||||
**IMPORTANTE:** Nunca subas el archivo `.env` o cualquier archivo con credenciales reales al repositorio. El archivo `.gitignore` está configurado para excluir archivos sensibles. Solo comparte `.env.example` con los nombres de las variables necesarias.
|
||||
|
||||
Reference in New Issue
Block a user