docs: Actualizar archivos README

- Se actualiza el README principal para ofrecer una descripción general del proyecto y dirigir a la documentación específica.
- Se actualiza el README de la aplicación 'ap-pos' con la URL correcta del repositorio para la clonación.
This commit is contained in:
Marco Gallegos
2025-08-13 07:24:45 -06:00
parent 727527e30d
commit 2354650cae
2 changed files with 20 additions and 72 deletions

View File

@@ -1,84 +1,32 @@
# AP-POS — Aplicación de Punto de Venta (v0.3)
# AP-POS — Aplicación de Punto de Venta
Esta es una aplicación de punto de venta (POS) diseñada para ser simple y robusta. Permite registrar clientes, gestionar movimientos (pagos, anticipos) e imprimir recibos.
La versión actual (v0.3) se enfoca en mejorar la experiencia de usuario (UX) y la interfaz (UI) para hacerla más intuitiva y agradable de usar.
Esta es una aplicación de punto de venta (POS) robusta y moderna, diseñada para ser simple, multiusuario y fácil de desplegar. Permite registrar clientes, gestionar ventas y usuarios, e imprimir recibos.
---
## Arquitectura y Tecnologías
* **Frontend**: Single-Page Application (SPA) con **HTML5, CSS3 y JavaScript (Vanilla)**.
* **Backend**: Servidor ligero con **Node.js y Express.js** que provee una API REST.
* **Backend**: Servidor ligero con **Node.js y Express.js** que provee una API RESTful.
* **Base de Datos**: **SQLite** (`ap-pos.db`), que hace la aplicación portable y fácil de respaldar.
## Novedades en la Versión 0.3
Se han implementado las siguientes mejoras en la interfaz y experiencia de usuario:
* **Diseño de Formularios Mejorado**:
* El formulario de **Clientes** ahora utiliza un diseño de dos columnas, haciendo que la información sea más fácil de leer y rellenar.
* El formulario de **Configuración** agrupa los campos de dirección (`Colonia` y `C.P.`) para mayor claridad y se han añadido textos de ejemplo (`placeholders`).
* **Estilo de Botones Consistente**:
* Se ha añadido más espacio y márgenes a los botones de acción.
* Los botones de "Limpiar" o "Cancelar" ahora son de color rojo para distinguirlos claramente de las acciones principales.
* **Flujo de Trabajo Optimizado**:
* Después de generar un recibo, el cursor se posiciona automáticamente en el campo "Cliente", agilizando la creación de un nuevo movimiento.
* **Títulos Clarificados**:
* Se han mejorado los títulos de algunas secciones para que sean más descriptivos (e.g., "Movimientos Recientes").
* **Contenerización**: Lista para desplegar con **Docker**.
## Características Principales
* Gestión de Clientes (Crear, Editar, Eliminar).
* Registro de Movimientos (Pagos, Anticipos).
* Generación de Folios automáticos e incrementales.
* Impresión de Recibos en formato de 58mm.
* Exportación de todos los movimientos a un archivo CSV.
* Configuración de los datos del negocio para personalizar los recibos.
* **Gestión de Ventas:** Crea nuevos movimientos (ventas, pagos) y genera recibos imprimibles.
* **Base de Datos de Clientes:** Administra una lista de clientes con su información de contacto.
* **Sistema de Roles Multi-usuario:**
- **Administrador:** Tiene acceso a todas las funciones, incluyendo un dashboard de estadísticas, la configuración del negocio y la gestión de usuarios.
- **Usuario:** Rol de vendedor con acceso limitado a la creación de ventas y gestión de clientes.
* **Dashboard (Solo Admin):** Visualiza estadísticas clave como ingresos totales, número de servicios y un gráfico de ingresos por tipo de servicio.
* **Exportación de Datos:** Exporta todos los movimientos a un archivo CSV.
* **Persistencia de Datos:** Toda la información se guarda en una base de datos SQLite.
## Requisitos del Sistema
## Cómo Empezar
* **Node.js**: Necesario para ejecutar el servidor backend. Descárgalo desde [nodejs.org](https://nodejs.org/).
* **Navegador Web**: Un navegador moderno como Google Chrome, Firefox, o Edge.
## Instalación y Ejecución
1. **Navega al directorio del proyecto**:
```bash
cd ap-pos
```
2. **Instala las dependencias**:
```bash
npm install
```
3. **Inicia el servidor**:
```bash
npm start
```
El servidor se ejecutará en `http://localhost:3000`.
4. **Abre la aplicación**:
Abre el archivo `index.html` en tu navegador.
## Estructura de Archivos
Para instrucciones detalladas sobre cómo instalar, ejecutar y desplegar la aplicación (tanto de forma local como con Docker), por favor consulta el archivo `README.md` dentro de la carpeta `ap-pos`.
```bash
cd ap-pos
cat README.md
```
ap-pos/
├─ index.html # Interfaz de usuario principal.
├─ styles.css # Estilos para la aplicación y la impresión.
├─ app.js # Lógica del frontend (eventos, renderizado, UI).
├─ storage.js # Módulo del frontend para comunicarse con la API.
├─ print.js # Lógica para generar el recibo.
├─ server.js # Servidor backend (Node.js/Express).
├─ package.json # Dependencias y scripts del proyecto.
├─ ap-pos.db # Archivo de la base de datos SQLite.
└─ src/
└─ logo.png # Logo del negocio.
```
## Consideraciones
* **Portabilidad**: Para mover la aplicación, copia la carpeta `ap-pos` completa.
* **Respaldo**: Para respaldar tus datos, simplemente haz una copia del archivo `ap-pos.db`.

View File

@@ -23,10 +23,10 @@ Este es un sistema de punto de venta (POS) simple y moderno basado en la web, di
### Pasos para la Ejecución
1. **Clonar el Repositorio (si aplica):**
1. **Clonar el Repositorio:**
```bash
git clone <url-del-repositorio>
cd ap-webapp/ap-pos
git clone https://github.com/marcogll/ap_pos.git
cd ap_pos/ap-pos
```
2. **Instalar Dependencias:**