🚖 App-Taxímetro: Tu Taxímetro Digital Moderno y Completo 🚖

✨ Descripción General

¡Bienvenido a App-Taxímetro, una solución de taxímetro digital completa, moderna y flexible! Este proyecto no es solo un taxímetro; es una plataforma completa construida con las mejores prácticas de desarrollo y lista para el mundo real. Calcula tarifas con precisión, ofrece interfaces para todo tipo de usuarios y está listo para escalar.

Características Destacadas:

• 💰 Cálculo Preciso: Configura tarifas base, tarifas por distancia/tiempo, recargos (nocturnos, festivos, etc.) ¡Todo personalizable!
• 💻 Múltiples Interfaces:
  • CLI: Control total desde la terminal.
  • GUI: Interfaz gráfica intuitiva (desarrollada con Tkinter, o especifica el framework que usaste).
  • Web (React + Vite): Interfaz moderna, responsiva y accesible desde cualquier dispositivo.
• 💾 Historial de Trayectos: Guarda automáticamente un registro detallado en formato JSON.
• ⚙️ Configuración Sencilla: Modifica las tarifas en un archivo config.json ¡Sin tocar código!
• 📝 Logging Detallado: Rastrea eventos importantes para depuración y análisis.
• 🧪 Pruebas Exhaustivas: Pruebas unitarias y de integración para garantizar la calidad y confiabilidad.
• 🐳 Listo para Contenedores: Despliegue fácil con Docker y Docker Compose.
• 🚀 CI/CD Integrado: Integración y despliegue continuos con GitHub Actions (automatización completa).

🏗️ Estructura del Proyecto

Una arquitectura bien organizada facilita la comprensión, el mantenimiento y la escalabilidad:

app-taximetro/
│
├── .github/workflows/app-config.yml    # Archivo de configuración de github actions
├── main.py                             # Archivo principal que ejecuta el programa
├── pyproject.toml                      # Archivo de configuración del proyecto
├── README.md                           # Documentación del proyecto
├── requirements.txt                    # Lista de dependencias del proyecto
├── test_imports.py                     # Archivo de comprobación de importaciones
├── Dockerfile                          # Archivo Dockerfile para contenedizar la aplicación
├── compose.yaml                        # Archivo de configuración de Docker Compose.
│
├── src/                                # Código fuente del proyecto
│   ├── __init__.py                     # Indica que el directorio es un paquete Python
│   ├── cli.py                          # Implementación de la interfaz de CLI
│   ├── gui.py                          # Implementación de la interfaz gráfica (GUI)
│   ├── taximeter.py                    # Implementación de la lógica del taxímetro
│   └── utils.py                        # Funciones auxiliares y utilitarias
│
├── tests/                              # Pruebas unitarias y de integración
│   ├── __init__.py                     # Indica que el directorio es un paquete Python
│   ├── test_cli.py                     # Pruebas para la lógica de la CLI 
│   ├── test_gui.py                     # Pruebas para la lógica de la GUI
│   ├── test_taximeter.py               # Pruebas para la lógica del taxímetro
│   └── test_utils.py                   # Pruebas para la lógica de las funciones auxiliares del taximetro
│
├── logs/                               # Archivos de logs
│   └── taximeter.log                   # Log principal del taxímetro
│
├── data/                               # Archivos de datos y configuración
│   ├── history.json                    # Registro histórico de trayectos
│   └── config.json                     # Archivo de configuración para las tarifas
│
└── client-app-taximetro/               # Directorio para el código del front-end
    ├── eslint.config.js                # Archivo de configuración para ESLint
    ├── index.html                      # Archivo HTML principal
    ├── vite.config.js                  # Archivo de configuración de Vite
    ├── package.json                    # Archivo de configuración de NPM
    ├── package-lock.json               # se crea automáticamente para registrar las versiones exactas de cada dependencia
    └── src/                            # Código fuente del front-end
        ├── assets/                     # Archivo principal de React
        ├── components/                 # Componente principal de la aplicación
        ├── layout/                     # Directorio para los componentes de React
        ├── pages/                      # Directorio para las páginas de la aplicación
        ├── router                      # Lógica para la navegación entre las diferentes páginas (enrutamiento).
        ├── index.css                   # Hoja de estilos CSS globales para la aplicación.
        └── main.jsx                    # El punto de entrada principal de la aplicación React

🚀 Instalación

1. Requisitos Previos:

   • Python 3.11+ (recomendado 3.11+)
   • pip (gestor de paquetes de Python)
   • Git (para clonar el repositorio)
   • Node.js y npm (para el frontend)
   • (Opcional) Docker y Docker Compose (para la contenerización)

2. Clonar el repositorio:

   git clone https://github.com/omarlsant/app-taximetro.git  # Reemplaza
   cd app-taximetro

3. Instalar dependencias (Backend/Python):

   pip install -r requirements.txt

4. Instalar dependencias (Frontend):

   cd frontend
   npm install
   cd ..

⚙️ Configuración

• Tarifas: Edita el archivo data/config.json para ajustar las tarifas del taxímetro. El archivo tiene la siguiente estructura (ejemplo):

  {
      "stopped_rate": 0.02,
      "moving_rate": 0.05
  }

  • moving_rate: Tarifa base por iniciar el trayecto.
  • stopped_rate: Tarifa por unidad de tiempo de espera (time_unit).
  • change_fee: Recargo adicional por trayectos nocturnos (puedes definir el horario en el código).
  • time_unit: Unidad de medida para waiting_rate ("second").

• Otras configuraciones: Si tienes variables de entorno, constantes, etc., considera agregarlas a un archivo de configuración separado (ej., src/config.py) o usar una librería como python-dotenv.

Uso

🕹️ Uso Interfaz de Línea de Comandos (CLI)

• python main.py --cli

🕹️ Interfaz de Gráfica de Usuario (GUI)

Ejecuta el programa principal:

• python main.py

✅ Ejecución de Pruebas

Pruebas unitarias con unittest:

• python -m unittest discover tests

🚀 CI/CD (Integración y Despliegue Continuos)

• El proyecto utiliza GitHub Actions para la integración continua (CI) y el despliegue continuo (CD). Las pruebas se ejecutan automáticamente en cada push y pull request, y la imagen de Docker se actualiza en Docker Hub.

🤝 Contribuciones

¡Las contribuciones son bienvenidas! Si tienes ideas, mejoras o correcciones, no dudes en abrir un issue o enviar un pull request.