creado un readme para mejor presentacion (si es que alguien alguna vez ve mi proyecto xD)
This commit is contained in:
35
README.MD
Normal file
35
README.MD
Normal file
@@ -0,0 +1,35 @@
|
||||
#Programa de caja (WIP)
|
||||
|
||||
### Que es?
|
||||
Es un pequeño programa pensado para realizar el conteo de dinero en la caja de nuestro restaurant familiar `:3`
|
||||
Ademas de tener la capacidad de generar informes en xls.
|
||||
|
||||
### Como utilizarlo?
|
||||
Para poder hacer build del programa es necesario importarlo a IntelliJ y hacer build del artifact `Programa Caja`, por ello esta incluida la carpeta `.idea` en el repositorio. IntelliJ deberia hacerse cargo de las dependencias del projecto (intente utilizar maven sinceramente pero no funciono muy bien al hacer una build junto desde el IDE).
|
||||
|
||||
Luego de hacer la build, en la carpeta `dist` se encontrara el archivo `caja.jar` el cual es el ejecutable, junto al el se encuentra el archivo `properties` que ya esta disponible en el repositorio, en este se puede seleccionar el look and feel que tendra el programa y el sistema de base de datos que se utilizara, por ahora solo tiene soporte para mysql y sqlite, siendo sqlite el que realmente funcionara ya que aun no termino de portar las querys para mysql.
|
||||
|
||||
Para crear la base de datos se tienen los scripts en la carpeta `database` donde estan los archivos `mysql.sql` y `sqlite.sql`, como dije anteriormente sqlite realmente esta al dia asi que ese deberia ser utilizado.
|
||||
Deberia usar un orm pero no e encontrado uno que realmente me venga bien, tomando en cuenta que estoy usando sqlite y no hay mucho soporte para el en los orm para java.
|
||||
|
||||
### Screenshots!
|
||||
##### Pantalla de ingresos
|
||||

|
||||
##### Pantalla de egresos
|
||||

|
||||
##### Pantalla de arqueo
|
||||

|
||||
##### Libro de ventas
|
||||

|
||||
|
||||
### Features?
|
||||
* Calcula total de ingresos y total de egresos
|
||||
* Generacion de informes, por ahora solo presente un informe de libro mensual
|
||||
* Pueden agregarse distintos tipos de ingresos y egresos facilmente (Aunque los informes deben ser modificados para agregar esta informacion en ellos)
|
||||
* Realiza los calculos del arqueo de la caja, comprobando cuanta diferencia existe entre los lo que se a rendido y lo que se debe rendir.
|
||||
* Se pueden realizar operaciones matematicas en los campos numericos, como son los campos de valor, efectivo y documentos.
|
||||
|
||||
### TODO
|
||||
- [x] Informe de libro mensual.
|
||||
- [ ] Informe de egresos.
|
||||
- [ ] Migrar a un ORM para mejor soporte de base de datos y mayor velocidad (Mi codigo de comunicacion con base de datos no es el mejor).
|
||||
Reference in New Issue
Block a user