spliit

Spliit est une alternative gratuite et open source à Splitwise. Vous pouvez soit utiliser l'instance officielle sur Spliit.app, soit déployer votre propre instance :

Caractéristiques

• Créez un groupe et partagez-le avec des amis
• Créer des dépenses avec description
• Afficher les soldes de groupe
• Créer des dépenses de remboursement
• Application Web progressive
• Sélectionner tout/aucun participant pour les dépenses
• Répartir les dépenses de manière inégale (#6)
• Marquer un groupe comme favori (#29)
• Dites à l'application qui vous êtes lors de l'ouverture d'un groupe (#7)
• Attribuer une catégorie aux dépenses (#35)
• Rechercher des dépenses dans un groupe (#51)
• Téléchargez et joignez des images aux dépenses (#63)
• Créer une dépense en scannant un reçu (#23)

Fonctionnalités entrantes possibles

• Possibilité de créer des dépenses récurrentes (#5)
• Importer les dépenses depuis Splitwise (#22)

Empiler

• Next.js pour l'application Web
• TailwindCSS pour le style
• shadcn/UI pour les composants de l'interface utilisateur
• Prisma pour accéder à la base de données
• Vercel pour l'hébergement (application et base de données)

Contribuer

Le projet est ouvert aux contributions. N'hésitez pas à ouvrir un ticket ou même une pull-request !

Si vous souhaitez contribuer financièrement et nous aider à maintenir l'application gratuite et sans publicité, vous pouvez également :

• ? Parrainez-moi (Sébastien), ou
• ? Faites un petit don unique.

Exécuter localement

1. Clonez le référentiel (ou forkez-le si vous avez l'intention de contribuer)
2. Démarrez un serveur PostgreSQL. Vous pouvez exécuter ./scripts/start-local-db.sh si vous n'avez pas déjà de serveur.
3. Copiez le fichier .env.example sous .env
4. Exécutez npm install pour installer les dépendances. Cela appliquera également les migrations de bases de données et mettra à jour Prisma Client.
5. Exécutez npm run dev pour démarrer le serveur de développement

Exécuter dans un conteneur

1. Exécutez npm run build-image pour créer l'image Docker à partir du Dockerfile
2. Copiez le fichier container.env.example sous container.env
3. Exécutez npm run start-container pour démarrer les conteneurs postgres et spliit2
4. Vous pouvez accéder à l'application en accédant à http://localhost:3000

Fonctionnalités d'inscription

Documents de dépenses

Spliit propose aux utilisateurs de télécharger des images (sur un compartiment AWS S3) et de les joindre aux dépenses. Pour activer cette fonctionnalité :

• Suivez les instructions dans les sections Compartiment S3 et Utilisateur IAM de next-s3-upload pour créer et configurer un compartiment S3 dans lequel les images seront stockées.
• Mettez à jour vos variables d'environnement avec les valeurs appropriées :

 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

Vous pouvez également utiliser d'autres fournisseurs S3 en fournissant un point de terminaison personnalisé :

 S3_UPLOAD_ENDPOINT = http://localhost:9000

Créer une dépense à partir du reçu

Vous pouvez proposer aux utilisateurs de créer une dépense en téléchargeant un reçu. Cette fonctionnalité s'appuie sur OpenAI GPT-4 avec Vision et un point de terminaison de stockage public S3.

Pour activer la fonctionnalité :

• Vous devez également activer la fonction de documents de dépenses (voir la section ci-dessus). Cela pourrait changer à l’avenir, mais pour l’instant, nous devons stocker des images pour que la numérisation des reçus fonctionne.
• Abonnez-vous à l'API OpenAI et accédez à GPT 4 avec Vision (vous devrez peut-être acheter des crédits à l'avance).
• Mettez à jour vos variables d'environnement avec les valeurs appropriées :

 NEXT_PUBLIC_ENABLE_RECEIPT_EXTRACT = true
OPENAI_API_KEY = XXXXXXXXXXXXXXXXXXXXXXXXXXXX

Déduire la catégorie du titre

Vous pouvez proposer aux utilisateurs de déduire automatiquement la catégorie de dépense du titre. Étant donné que cette fonctionnalité repose sur un abonnement OpenAI, suivez les instructions d'inscription ci-dessus et configurez les variables d'environnement suivantes :

 NEXT_PUBLIC_ENABLE_CATEGORY_EXTRACT = true
OPENAI_API_KEY = XXXXXXXXXXXXXXXXXXXXXXXXXXXX 

Licence

MIT, voir LICENCE.