spliit

Spliit es una alternativa gratuita y de código abierto a Splitwise. Puedes usar la instancia oficial en Spliit.app o implementar tu propia instancia:

Características

• Crea un grupo y compártelo con amigos.
• Crear gastos con descripción
• Mostrar saldos de grupo
• Crear gastos de reembolso
• Aplicación web progresiva
• Seleccionar todos/ningún participante para gastos
• Dividir los gastos de manera desigual (#6)
• Marcar un grupo como favorito (#29)
• Dígale a la aplicación quién es usted al abrir un grupo (#7)
• Asignar una categoría a los gastos (#35)
• Buscar gastos en un grupo (#51)
• Subir y adjuntar imágenes a gastos (#63)
• Cree gastos escaneando un recibo (#23)

Posibles funciones entrantes

• Capacidad para crear gastos recurrentes (#5)
• Gastos de importación desde Splitwise (#22)

Pila

• Next.js para la aplicación web
• TailwindCSS para el estilo
• shadcn/UI para los componentes de la interfaz de usuario
• Prisma para acceder a la base de datos.
• Vercel para hosting (aplicación y base de datos)

Contribuir

El proyecto está abierto a contribuciones. ¡No dudes en abrir un problema o incluso una solicitud de extracción!

Si quieres contribuir económicamente y ayudarnos a mantener la aplicación gratuita y sin publicidad, también puedes:

• ? Patrocinarme (Sebastien), o
• ? Haga una pequeña donación única.

Ejecutar localmente

1. Clona el repositorio (o bifurca si tienes intención de contribuir)
2. Inicie un servidor PostgreSQL. Puede ejecutar ./scripts/start-local-db.sh si aún no tiene un servidor.
3. Copie el archivo .env.example como .env
4. Ejecute npm install para instalar las dependencias. Esto también aplicará las migraciones de bases de datos y actualizará Prisma Client.
5. Ejecute npm run dev para iniciar el servidor de desarrollo

Ejecutar en un contenedor

1. Ejecute npm run build-image para crear la imagen de la ventana acoplable desde Dockerfile
2. Copie el archivo container.env.example como container.env
3. Ejecute npm run start-container para iniciar los contenedores postgres y split2
4. Puede acceder a la aplicación navegando a http://localhost:3000

Funciones de suscripción

Documentos de gastos

Spliit ofrece a los usuarios cargar imágenes (en un depósito de AWS S3) y adjuntarlas a los gastos. Para habilitar esta característica:

• Siga las instrucciones en las secciones de usuario de IAM y depósito de S3 de next-s3-upload para crear y configurar un depósito de S3 donde se almacenarán las imágenes.
• Actualice las variables de su entorno con los valores apropiados:

 NEXT_PUBLIC_ENABLE_EXPENSE_DOCUMENTS = true
S3_UPLOAD_KEY = AAAAAAAAAAAAAAAAAAAA
S3_UPLOAD_SECRET = AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
S3_UPLOAD_BUCKET = name-of-s3-bucket
S3_UPLOAD_REGION = us-east-1

También puede utilizar otros proveedores de S3 proporcionando un punto final personalizado:

 S3_UPLOAD_ENDPOINT = http://localhost:9000

Crear gasto desde el recibo

Puede ofrecer a los usuarios crear gastos cargando un recibo. Esta característica se basa en OpenAI GPT-4 con Vision y un punto final de almacenamiento público S3.

Para habilitar la función:

• También debe habilitar la función de documentos de gastos (consulte la sección anterior). Eso podría cambiar en el futuro, pero por ahora necesitamos almacenar imágenes para que el escaneo de recibos funcione.
• Suscríbase a OpenAI API y obtenga acceso a GPT 4 con Vision (es posible que deba comprar créditos por adelantado).
• Actualice sus variables de entorno con los valores apropiados:

 NEXT_PUBLIC_ENABLE_RECEIPT_EXTRACT = true
OPENAI_API_KEY = XXXXXXXXXXXXXXXXXXXXXXXXXXXX

Deducir categoría del título

Puede ofrecer a los usuarios deducir automáticamente la categoría de gastos del título. Dado que esta función depende de una suscripción a OpenAI, siga las instrucciones de registro anteriores y configure las siguientes variables de entorno:

 NEXT_PUBLIC_ENABLE_CATEGORY_EXTRACT = true
OPENAI_API_KEY = XXXXXXXXXXXXXXXXXXXXXXXXXXXX 

Licencia

MIT, ver LICENCIA.