PR Extractor - Generador de Cuentas de Cobro

Aplicación de escritorio construida con Electron para extraer Pull Requests de GitHub y generar cuentas de cobro profesionales en formato PDF.

Características

• Extracción automática de Pull Requests de repositorios GitHub
• Filtrado por mes y autor específico
• Generación de cuentas de cobro en PDF con formato profesional
• Agregar items personalizados además de los PRs
• Auto-completado de formularios desde variables de entorno
• Firma digital en los documentos
• Interfaz gráfica intuitiva con tema oscuro

Requisitos Previos

• Node.js v14 o superior
• npm o yarn
• Token de acceso personal de GitHub con permisos de lectura de repositorios

Instalación

1. Clona el repositorio:

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

2. Instala las dependencias:

npm install

3. Configura las variables de entorno:

cp .env.example .env

4. Edita el archivo .env con tu información:
   • GITHUB_TOKEN: Tu token de acceso personal de GitHub
   • REPO_OWNER: Propietario del repositorio
   • REPO_NAME: Nombre del repositorio
   • Completa los demás campos según tus necesidades

Uso

Modo Desarrollo

npm run electron

Compilar para Producción

npm run build

Seguridad

IMPORTANTE: Nunca compartas tu archivo .env o expongas tu token de GitHub públicamente.

• El archivo .env está incluido en .gitignore
• Usa .env.example como plantilla
• Los tokens de GitHub deben tener únicamente los permisos necesarios

Generación de PDFs

La aplicación genera cuentas de cobro con:

• Información del cobrador y cliente
• Lista de Pull Requests o items personalizados
• Conversión automática de valores numéricos a palabras
• Firma digital
• Fecha y ciudad de emisión

Tecnologías

• Electron: Framework para aplicaciones de escritorio
• Node.js: Entorno de ejecución
• PDFKit: Generación de documentos PDF
• Octokit: Cliente para la API de GitHub
• Feather Icons: Iconografía

Licencia

Este proyecto está bajo la Licencia MIT - ver el archivo LICENSE para más detalles.

Autor

Desarrollado con ❤️ para facilitar la facturación de servicios de desarrollo.

Contribuciones

Las contribuciones son bienvenidas. Por favor:

1. Haz fork del proyecto
2. Crea una rama para tu feature (git checkout -b feature/AmazingFeature)
3. Commit tus cambios (git commit -m 'Add some AmazingFeature')
4. Push a la rama (git push origin feature/AmazingFeature)
5. Abre un Pull Request

Notas Importantes

• Los archivos PDF generados no se suben al repositorio
• Asegúrate de tener una imagen de firma en formato PNG o JPG
• La aplicación requiere conexión a internet para acceder a la API de GitHub