spliit

Splitwise ist eine kostenlose Open-Source-Alternative zu Splitwise. Sie können entweder die offizielle Instanz bei Spliit.app verwenden oder Ihre eigene Instanz bereitstellen:

Merkmale

• Erstellen Sie eine Gruppe und teilen Sie sie mit Freunden
• Erstellen Sie Ausgaben mit Beschreibung
• Gruppensalden anzeigen
• Erstellen Sie Erstattungsaufwendungen
• Progressive Web-App
• Wählen Sie alle/keine Teilnehmer für Ausgaben aus
• Ausgaben ungleichmäßig aufteilen (#6)
• Eine Gruppe als Favorit markieren (#29)
• Sagen Sie der Anwendung, wer Sie sind, wenn Sie eine Gruppe eröffnen (#7)
• Den Ausgaben eine Kategorie zuweisen (#35)
• Nach Ausgaben in einer Gruppe suchen (#51)
• Bilder hochladen und an Spesen anhängen (#63)
• Erstellen Sie eine Ausgabe, indem Sie eine Quittung scannen (#23)

Mögliche eingehende Funktionen

• Möglichkeit, wiederkehrende Ausgaben zu erstellen (#5)
• Ausgaben aus Splitwise importieren (#22)

Stapel

• Next.js für die Webanwendung
• TailwindCSS für das Styling
• shadcn/UI für die UI-Komponenten
• Prisma für den Zugriff auf die Datenbank
• Vercel für Hosting (Anwendung und Datenbank)

Beitragen

Das Projekt ist offen für Beiträge. Fühlen Sie sich frei, ein Issue oder sogar einen Pull-Request zu eröffnen!

Wenn Sie einen finanziellen Beitrag leisten und uns helfen möchten, die Anwendung kostenlos und ohne Werbung zu halten, können Sie auch:

• ? Sponsern Sie mich (Sebastien), oder
• ? Machen Sie eine kleine einmalige Spende.

Lokal ausführen

1. Klonen Sie das Repository (oder forken Sie es, wenn Sie einen Beitrag leisten möchten)
2. Starten Sie einen PostgreSQL-Server. Sie können ./scripts/start-local-db.sh ausführen, wenn Sie noch keinen Server haben.
3. Kopieren Sie die Datei .env.example als .env
4. Führen Sie npm install aus, um Abhängigkeiten zu installieren. Dies gilt auch für Datenbankmigrationen und die Aktualisierung des Prisma-Clients.
5. Führen Sie npm run dev aus, um den Entwicklungsserver zu starten

In einem Container ausführen

1. Führen Sie npm run build-image aus, um das Docker-Image aus der Docker-Datei zu erstellen
2. Kopieren Sie die Datei container.env.example als container.env
3. Führen Sie npm run start-container aus, um die Postgres- und Split2-Container zu starten
4. Sie können auf die App zugreifen, indem Sie zu http://localhost:3000 navigieren

Opt-in-Funktionen

Spesenbelege

Spliit bietet Benutzern die Möglichkeit, Bilder hochzuladen (in einen AWS S3-Bucket) und sie an Ausgaben anzuhängen. So aktivieren Sie diese Funktion:

• Befolgen Sie die Anweisungen in den Abschnitten „S3-Bucket“ und „IAM-Benutzer“ von next-s3-upload, um einen S3-Bucket zu erstellen und einzurichten, in dem Bilder gespeichert werden.
• Aktualisieren Sie Ihre Umgebungsvariablen mit den entsprechenden Werten:

 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

Sie können auch andere S3-Anbieter nutzen, indem Sie einen benutzerdefinierten Endpunkt bereitstellen:

 S3_UPLOAD_ENDPOINT = http://localhost:9000

Erstellen Sie eine Ausgabe aus dem Beleg

Sie können Benutzern anbieten, Ausgaben zu erstellen, indem sie eine Quittung hochladen. Diese Funktion basiert auf OpenAI GPT-4 mit Vision und einem öffentlichen S3-Speicherendpunkt.

So aktivieren Sie die Funktion:

• Sie müssen auch die Spesenbelegfunktion aktivieren (siehe Abschnitt oben). Das könnte sich in Zukunft ändern, aber zunächst müssen wir Bilder speichern, damit das Scannen von Belegen funktioniert.
• Abonnieren Sie die OpenAI API und erhalten Sie Zugriff auf GPT 4 mit Vision (möglicherweise müssen Sie Credits im Voraus kaufen).
• Aktualisieren Sie Ihre Umgebungsvariablen mit den entsprechenden Werten:

 NEXT_PUBLIC_ENABLE_RECEIPT_EXTRACT = true
OPENAI_API_KEY = XXXXXXXXXXXXXXXXXXXXXXXXXXXX

Kategorie aus Titel ableiten

Sie können Benutzern anbieten, die Ausgabenkategorie automatisch aus dem Titel abzuleiten. Da diese Funktion auf einem OpenAI-Abonnement basiert, befolgen Sie die oben genannten Anmeldeanweisungen und konfigurieren Sie die folgenden Umgebungsvariablen:

 NEXT_PUBLIC_ENABLE_CATEGORY_EXTRACT = true
OPENAI_API_KEY = XXXXXXXXXXXXXXXXXXXXXXXXXXXX 

Lizenz

MIT, siehe LIZENZ.