spliit

Split é uma alternativa gratuita e de código aberto ao Splitwise. Você pode usar a instância oficial em Splitit.app ou implantar sua própria instância:

Características

• Crie um grupo e compartilhe-o com amigos
• Crie despesas com descrição
• Exibir saldos de grupo
• Criar despesas de reembolso
• Aplicativo Web Progressivo
• Selecione todos/nenhum participante para despesas
• Divida as despesas de forma desigual (nº 6)
• Marcar um grupo como favorito (#29)
• Diga ao aplicativo quem você é ao abrir um grupo (#7)
• Atribuir uma categoria às despesas (#35)
• Pesquise despesas em um grupo (#51)
• Faça upload e anexe imagens às despesas (#63)
• Crie despesas digitalizando um recibo (#23)

Possíveis recursos de entrada

• Capacidade de criar despesas recorrentes (#5)
• Despesas de importação do Splitwise (#22)

Pilha

• Next.js para o aplicativo da web
• TailwindCSS para o estilo
• shadcn/UI para os componentes da UI
• Prisma para acessar o banco de dados
• Vercel para hospedagem (aplicativo e banco de dados)

Contribuir

O projeto está aberto a contribuições. Sinta-se à vontade para abrir um problema ou até mesmo uma solicitação pull!

Se quiser contribuir financeiramente e nos ajudar a manter o aplicativo gratuito e sem anúncios, você também pode:

• ? Patrocine-me (Sebastien), ou
• ? Faça uma pequena doação única.

Execute localmente

1. Clone o repositório (ou faça um fork se você pretende contribuir)
2. Inicie um servidor PostgreSQL. Você pode executar ./scripts/start-local-db.sh se ainda não tiver um servidor.
3. Copie o arquivo .env.example como .env
4. Execute npm install para instalar dependências. Isso também aplicará migrações de banco de dados e atualizará o Prisma Client.
5. Execute npm run dev para iniciar o servidor de desenvolvimento

Execute em um contêiner

1. Execute npm run build-image para construir a imagem docker a partir do Dockerfile
2. Copie o arquivo container.env.example como container.env
3. Execute npm run start-container para iniciar os contêineres postgres e spliit2
4. Você pode acessar o aplicativo navegando até http://localhost:3000

Recursos de aceitação

Documentos de despesas

O Spliit oferece aos usuários o upload de imagens (para um bucket AWS S3) e anexá-las às despesas. Para ativar este recurso:

• Siga as instruções nas seções do bucket S3 e do usuário IAM de next-s3-upload para criar e configurar um bucket S3 onde as imagens serão armazenadas.
• Atualize suas variáveis ​​de ambiente com valores apropriados:

 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

Você também pode usar outros provedores S3 fornecendo um endpoint personalizado:

 S3_UPLOAD_ENDPOINT = http://localhost:9000

Criar despesa a partir do recebimento

Você pode oferecer aos usuários a criação de despesas enviando um recibo. Este recurso depende do OpenAI GPT-4 com Vision e de um endpoint de armazenamento público S3.

Para ativar o recurso:

• Você também deve ativar o recurso de documentos de despesas (consulte a seção acima). Isso pode mudar no futuro, mas por enquanto precisamos armazenar imagens para que a digitalização de recibos funcione.
• Assine a API OpenAI e tenha acesso ao GPT 4 com Vision (talvez seja necessário comprar créditos com antecedência).
• Atualize suas variáveis ​​de ambiente com valores apropriados:

 NEXT_PUBLIC_ENABLE_RECEIPT_EXTRACT = true
OPENAI_API_KEY = XXXXXXXXXXXXXXXXXXXXXXXXXXXX

Deduzir categoria do título

Você pode oferecer aos usuários a dedução automática da categoria de despesas do título. Como esse recurso depende de uma assinatura OpenAI, siga as instruções de inscrição acima e configure as seguintes variáveis ​​de ambiente:

 NEXT_PUBLIC_ENABLE_CATEGORY_EXTRACT = true
OPENAI_API_KEY = XXXXXXXXXXXXXXXXXXXXXXXXXXXX 

Licença

MIT, consulte LICENÇA.