briefkasten

？ briefkasten

Briefkasten （EN：Mailbox）-Am Haus -Oder Wohnungseingang AngebrachterbehälterfürdiedemempfängerZugestellten[Post] Sendungen

自己ホストのブックマークアプリケーション。任意のPrisma互換データベース（MySQL、Postgres、SQLiteなど）で動作します。

警告

BriefKasten V2は現在、https://dev.briefkastenhq.comでベータ版で入手できます

ベータ期間後、データベースがドロップされるため、現在の（V1） briefkastenhq.comからすべての既存のデータを新しいバージョンに移行できます。私はすでに新しいドキュメントに取り組んでいますが、もちろんV1ドキュメントはまだ利用可能です。バグが見つかった場合、または支援したい場合は、 ndom91/sveltekastenまたはndom91/briefkasten-docsで貢献できます。

無料インスタンス：Briefkastenhq.com [docs]

？スクリーンショット

？特徴

• ブラウザ拡張機能で保存します
• 自動タイトルと説明抽出
• 保存するページ上のドラッグアンドドロップURL
• キーボードショートカット
• カテゴリとタグで整理します
• 標準のHTML形式からブックマークをインポートおよびエクスポートします
• 画像をブックマークする背景ジョブを取得します
• 複数のビュー
• フルテキスト検索
• REST API
• oauth +メールマジックリンクログイン

？前提条件

このアプリケーションを自己ホストするには、次のような枝が必要です。

1. next.jsアプリケーション用のサーバー /ホスティングプラットフォーム（すなわち、vercel / netlify）
2. OAuthログインの場合、nextauth.jsによってサポートされているプロバイダーのいずれかの開発者アカウント
3. Prismaで動作するデータベース（つまり、mysql、postgres、sqliteなど）
4. 画像ホスティングスペース（つまり、Supabase / ImageKit / Cloudinary）（オプション）

これらはすべて、画像ホスター以外は比較的単純です。これは、画像をデータベースに入れないように選択されました。 BriefKastenHQ.comのアプリケーションの例は、Supabaseストレージを使用していますが、CloudinaryやSimple S3バケットなどの他の同様のプロバイダーもジョブを行います。 Supabaseを選びました。なぜなら、彼らは使いやすいSDK、まともな無料層であり、私はすでに彼らのPostgresサービスを使用していたからです。

上記のすべてのプロバイダーでアカウントのセットアップを取得した後、または独自のインフラストラクチャを用意した後、以下の次のステップに進むことができます。

はじめる

1. リポジトリをクローンします

$ git clone [email protected]:ndom91/briefkasten.git && cd briefkasten

2. 依存関係をインストールします

$ pnpm install

3. .env.exampleファイルを.envにコピーし、お気に入りのテキストエディターで開き、環境変数を入力します。

$ cp .env.example .env
$ vim .env

この環境変数ファイルでは、少なくともDATABASE_URL 、 NEXTAUTH_URLおよびNEXTAUTH_SECRETを入力してください。残りの環境変数は、使用するサービス /機能によって異なります。たとえば、OAUTHログイン用のGoogle/Githubおよび/またはオブジェクトストレージ用のSupabase。

4. サーバーを開始してください！

// First time only
$ pnpm db:push

// dev
$ pnpm dev

// prod
$ pnpm build
$ pnpm start

？ Docker

DockerでBriebkastenを自己ホストすることもできます。そうするためには、次のことをしなければなりません。

1. dockerとdocker-composeをインストールします。
2. リポジトリをクローンし、 .env.exampleを.envファイルにコピーします。
   1. ここでは、 DATABASE_URLおよびNEXTAUTH_*環境変数に少なくとも入力する必要があります。
   2. PostgresコンテナのDATABASE_URL DATABASE_URL=postgres://bkAdmin:briefkasten@postgres:5432/briefkasten?sslmode=disableある必要があります
3. docker-compose up -dリポジトリのルートで実行します。これにより、アプリケーションとデータベースが開始されます。
4. 最初の開始後、データベースを手動でシードする必要があります。これは、アプリコンテナ（ bk-app ）を介して最も簡単に実行できます。
   1. docker exec -it bk-app /bin/bashを実行して、コンテナ内の端末セッションに入ります。
   2. 次に、 pnpm db:push 。これにより、データベーススキーマがPrismaから構成されたデータベースにプッシュされます。
5. これで、デフォルトのhttp://localhost:3000でアプリケーションとデータベースが稼働している必要があります

詳細については、ドキュメントのDockerセクションをご覧ください。

？関連している

？ Android共有メニューから保存します

このオープンソースアプリケーションHTTPショートカットを使用すると、動的入力、つまりWebページのURLとタイトルを使用してPOSTリクエストを実行する「共有メニュー」項目を作成できます。これにより、携帯電話からBriefKastenにアイテムを簡単に共有できます！ドキュメントの詳細。

？ブラウザ拡張機能

作品には、Webを閲覧しながらボールトにWebサイトを追加するために使用できるコンパニオンブラウザの拡張機能があります。 ndom91/briefkasten-extensionおよびChrome Extensionストアで見つけることができます。その詳細については、そのリポジトリの詳細。

？‍？スクリーンショットジョブ

また、有効な画像がないブックマークを入力するバックグラウンドジョブもあります。 ndom91/briefkasten-scrapeリポジトリにあります。このジョブは、GitHubアクションで2時間ごとに実行され、一度に10のブックマークを処理します。

？貢献

このプロジェクトは、あらゆる貢献に対して開かれています！ Eslint /よりきれいな設定に固執してください、そして私はあなたの問題 / PRを見て喜んでいますか？

ライセンス

mit