spliit

Split は、Splitwise に代わる無料のオープンソースです。 Spliit.app の公式インスタンスを使用することも、独自のインスタンスをデプロイすることもできます。

特徴

• グループを作成して友達と共有する
• 説明付きの経費を作成する
• グループ残高の表示
• 償還経費の作成
• プログレッシブウェブアプリ
• 経費の参加者全員を選択する/参加者を選択しない
• 経費を不均等に分割する (#6)
• グループをお気に入りとしてマークする (#29)
• グループを開くときにアプリケーションに自分が誰であるかを伝えます (#7)
• 経費にカテゴリを割り当てる (#35)
• グループ内の経費を検索する (#51)
• 画像をアップロードして経費に添付する (#63)
• 領収書をスキャンして経費を作成する (#23)

追加される可能性のある機能

• 定期的な経費を作成する機能 (#5)
• Splitwise から経費をインポート (#22)

スタック

• Web アプリケーション用の Next.js
• TailwindCSS のスタイリング
• UIコンポーネントのshadcn/UI
• データベースにアクセスするための Prisma
• ホスティング用の Vercel (アプリケーションとデータベース)

貢献する

このプロジェクトは寄付を受け付けています。気軽にイシューやプルリクエストを開いてください。

経済的に貢献し、アプリケーションを無料で広告なしで維持できるように協力したい場合は、次のこともできます。

• ?私（セバスチャン）のスポンサーになってください、または
• ?少額の 1 回限りの寄付をしてください。

ローカルで実行

1. リポジトリのクローンを作成します (または、貢献する場合はフォークします)。
2. PostgreSQLサーバーを起動します。サーバーをまだ持っていない場合は、 ./scripts/start-local-db.shを実行できます。
3. ファイル.env.example .envとしてコピーします。
4. npm install実行して依存関係をインストールします。これにより、データベースの移行も適用され、Prisma Client が更新されます。
5. npm run dev実行して開発サーバーを起動します。

コンテナ内で実行する

1. npm run build-image実行して、Dockerfile から Docker イメージをビルドします。
2. ファイルcontainer.env.example container.envとしてコピーします。
3. npm run start-container実行して、postgres コンテナと spliit2 コンテナを起動します。
4. http://localhost:3000 にアクセスしてアプリにアクセスできます。

オプトイン機能

経費書類

Split では、ユーザーが画像を (AWS S3 バケットに) アップロードし、経費に添付することができます。この機能を有効にするには:

• next-s3-upload のS3 バケットとIAM ユーザーセクションの手順に従って、画像が保存される S3 バケットを作成して設定します。
• 環境変数を適切な値で更新します。

 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

カスタム エンドポイントを提供することで、他の S3 プロバイダーを使用することもできます。

 S3_UPLOAD_ENDPOINT = http://localhost:9000

領収書から経費を作成する

領収書をアップロードすることで経費を作成するようユーザーに提案できます。この機能は、Vision とパブリック S3 ストレージ エンドポイントを備えた OpenAI GPT-4 に依存しています。

機能を有効にするには:

• 経費書類機能も有効にする必要があります (上記のセクションを参照)。将来的には変更される可能性がありますが、現時点ではレシートのスキャンを機能させるために画像を保存する必要があります。
• OpenAI API をサブスクライブし、Vision を使用して GPT 4 にアクセスします (事前にクレジットを購入する必要がある場合があります)。
• 環境変数を適切な値で更新します。

 NEXT_PUBLIC_ENABLE_RECEIPT_EXTRACT = true
OPENAI_API_KEY = XXXXXXXXXXXXXXXXXXXXXXXXXXXX

タイトルからカテゴリを推測する

タイトルから経費カテゴリを自動的に推測するようにユーザーに提供できます。この機能は OpenAI サブスクリプションに依存しているため、上記のサインアップ手順に従い、次の環境変数を構成します。

 NEXT_PUBLIC_ENABLE_CATEGORY_EXTRACT = true
OPENAI_API_KEY = XXXXXXXXXXXXXXXXXXXXXXXXXXXX 

ライセンス

MIT、ライセンスを参照してください。