.. app-telcel documentation master file, created by sphinx-quickstart on Wed Apr 27 16:34:10 2022. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. Welcome to app-telcel's documentation! ====================================== .. image:: https://readthedocs.org/projects/app-telcel/badge/?version=latest .. toctree:: :maxdepth: 2 :caption: Contents: Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` Descripcion ============ app-telcel es una aplicacion de escritorio que permite registrar clientes y cuentas para capturar los registros de los cargos telefonicos que se realizan cada mes. Tambien permite imprimir y exportar reportes para consultar saldos para realizar las cobranzas. Problema Identificado: ======================= El problema inicial de donde nacio la idea fue cuando vi que se perdian muchas veces los datos de cuanto debia cada cliente. Con el fin de guardar los registros se creo esta aplicacion para poder registrar los datos mensualmente y poder imprimir los reportes correspondientes. Otra problematica identificada fue que cada cliente puede tener varias cuentas pero no se sumaba entre si, entonces se necesita una aplicacion que sume el total de todas las cuentas registradas a un cliente. Solucion: ========= La solucion a esta problematica consiste en crear una aplicacion con Java y Maven para el registro de datos. Las tecnologias usadas para este proyecto son: Java Maven MySql Git Jasper Studio Arquitectura: ============= Diagrama de Clases: https://lucid.app/lucidchart/e7b591db-3a14-4cae-a844-5fb48874e104/edit?invitationId=inv_2ba25033-1638-4bc7-8890-755e70ee55f5 Diagrama de Arquitectura: https://lucid.app/lucidchart/1bf6bc92-18ca-41d6-ad05-2e2897ae86d9/edit?invitationId=inv_dc20b9c6-671f-4e81-bd6c-ec941afdf1da Requerimientos: =============== Los requerimientos para ejecutar esta aplicacion son: Se debe tener instalado el paquete jdk de java 16.0 El cual se puede descargar aqui: https://www.oracle.com/java/technologies/javase/jdk16-archive-downloads.html Se deben agregar las variables de entorno para que se pueda ejecutar. Instalacion: ============ El proyecto cuenta con un release con la version 1.0.0 con las funciones basicas es una version preeliminar ya que todavia falta agregarle codigo. Simplemente se tiene que descargar el JAR compilado anexo y ejecutarlo para que se ejecute el programa. Anexo tambien esta el codigo fuente para realizar modificaciones. a. ¿Cómo instalar el ambiente de desarrollo? Se puede instalar cualquier IDE para poder configurar y hacer adaptaciones al programa El que se uso para la creacion de esta version preeliminar es Apache Netbeans que se puede descargar en el siguiente link https://netbeans.apache.org/ Tambien hay que consultar la documentacion oficial para la instalacion y uso de esta plataforma en la siguiente liga. https://netbeans.apache.org/kb/ b. ¿Cómo ejecutar pruebas manualmente? Las pruebas se pueden ejecutar usando el cmd con el jar ejecutable descargado. Descargar el JAR En el cmd del sistema ir a la ruta del archivo y ejecutar el siguiente comando java -jar telcel-1.0-SNAPSHOT.jar Uso: ===== El uso de la aplicacion es sencillo solo es necesario descargar el Jar ejecutable que se puede encontrar en el relaese del repositorio. Una vez descargardo se puede ejecutar sin problema. Nuevas funcionalidades y arreglo de problematicas todavia estan en proceso. Contribucion: ============== Para clonar el escritorio crear un nuevo branch para hacer contribuciones pueden consultar la documentacion de GitHub https://docs.github.com/es Para poder contribuir all projecto pueden hacer una solicitud para analizar y agregarlos al projecto. Roadmap: ======== License ------- The project is licensed under the MIT license.