sanraro/libretpv repository overview

--

################################################################################ Copyright (C) 2011-2020 Santiago Ramos

This file is part of libreTPV.

libreTPV is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

TPV is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for further details, currently published at http://www.gnu.org/copyleft/gpl.html⁠ or in the gpl.txt in the licence folder of this distribution.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, Dt. 02110-1301, USA.

Authors: Santiago Ramos You may contact the copyright holder at: Email: [email protected]⁠ ################################################################################

++

NOTAS a la versión 0.x de libreTPV

= Demo online.

La aplicación está disponible para pruebas en http://libretpv-demo.sitiodistinto.net/⁠

Usuario: [email protected]⁠ Password: admin-demo

= Instalación.

En este punto solo enumeramos los pasos generales para una instalación. Remitimos al documento de instalación (INSTALL) para una explicación mas detallada.

1. Instalar Rails.
2. Crear el usuario de la base de datos y configurarlo en la aplicación (database.yml).
3. Crear la base de datos (rake db:create:all) y el modelo de datos (rake db:schema:load).
4. Instalar las gemas extras que necesita el sistema (rake gems:install).
5. Instalar y configurar mod-rails (o cualquier motor rails) con apache (o con cualquier otro servidor web).

Para el resto de módulos remitimos a la documentación sobre instalación general del sistema recogida en el archivo INSTALL

= Descripción de libreTPV

LibreTPV es una aplicación de gestión de tiendas pequeñas y medianas. Está diseñada de forma intuitiva y clara, de forma que el uso de la herramienta sea lo más rápido posible. Sus funcionalidades son:

• Gestión de proveedores
• Gestión de clientes
• Gestión de stock
• Ventas con distintas formas de pago
• Impresión de tickets de venta y control de apertura de caja
• Utilización de lector de código de barras para realizar las ventas y los albaranes de entrada de productos
• Uso de ISBN para gestión de libros con rellenado automático de los datos de este.
• Ventas de productos no inventariados
• Generación de etiquetas de venta con códigos de barras
• Descuento personalizado por cliente y proveedor
• Arqueo y cierre de caja
• Gestión de tipos de IVA
• Control de pagos de facturas de proveedores y de ventas.
• Impresión de PDFs de facturas para clientes
• Gestión de facturas de servicios asociados a la tienda (autónomos, alquiler, luz, teléfono, ...)
• Informes de libro diario y posición global (con desglose de iva repercutido y soportado para declaraciones, irpf, ...)
• Exportaciones a hojas de cálculo excel
• Bonos descuento para fidelización de compras

= Funcionalidades futuras

• Control de vendedores
• Múltiples puestos de venta
• Sincronización de inventario y ventas con sistema de eCommerce (tiendas web)
• Prepago por cliente

= Breve descripción general de la estructura

== Secciones y navegación

Las secciones es un elemento de navegación superior que se introduce sobre la forma de navegación habitual de rails. Las rutas del sistema son de la forma:

/seccion/controlador/accion/id

Para cada sección se muestran una serie de controladores y unas acciones de ese controlador determinadas.

Las 4 secciones que tiene actualmente el sistema son:

== Vistas

Las vistas responden al modelo clásico de Rails y concretamente:

• Existe un único layout general para todo el sistema.

== Helper

Existe un único helper general con todos los métodos específicos de las vistas ApplicationHelper. En este helper están los métodos que presentan los elementos generales de navegación:

== CSS

• tpv.css

= Changelog y "TODO"

El listado de las novedades y cambios de esta versión de libreTPV se puede consultar En el fichero "changelog". Los cambios pendientes a implementar en futuras versiones aparecen descritas en el fichero "TODO".

= Licencia

libreTPV está licenciado bajo GPLv3. Una descripción de dicha licencia, así como las condiciones de uso, copia, modificación y distribución aparecen en el fichero "COPYING".

libreTPV está desarrollado por el equipo referido en el archivo "AUTHORS". El Copyright de libreTPV pertenece a Santiago Ramos [email protected]⁠