briefkasten

？ hivekasten

hivkasten （en：郵箱） - haus -oder wohnungseingang angebrachter behlterfürdemempfängerempfängerzugestellten [post] sendungen

自主書籤應用程序。與任何兼容數據庫（MySQL，Postgres，Sqlite等）一起使用

警告

hithkasten v2目前可在beta上找到，網址為https://dev.briefkastenhq.com

在Beta期間之後，數據庫將被刪除，以便我們可以將當前（V1）簡介briefkastenhq.com遷移到新版本。我已經在新文檔上工作了，但是V1文檔當然仍然可用。如果您發現任何錯誤或其他想幫助，則可以在ndom91/sveltekasten或ndom91/briefkasten-docs上貢獻。

免費實例：hivekastenhq.com [docs]

？屏幕截圖

？特徵

• 由瀏覽器擴展節保存
• 自動標題和說明提取
• 頁面上的拖放URL保存
• 鍵盤快捷鍵
• 按類別和標籤組織
• 來自標準HTML格式的導入和導出書籤
• 書籤圖像獲取背景工作
• 多個視圖
• 完整搜索
• REST API
• Oauth +電子郵件魔術鏈接登錄

？先決條件

要自助託管此應用程序，您將需要以下細分：

1. Next.js應用程序的服務器 /託管平台（即Vercel / Netlify）
2. 對於Oauth Login，NextAuth.js支持的任何一個提供商的開發人員帳戶
3. 與Prisma一起使用的數據庫（即MySQL，Postgres，Sqlite等）
4. 圖像託管空間（即supabase / imagekit / cloudinary）（可選）

除了圖像霍斯特，這些都是相對直截了當的。選擇這是為了避免將圖像放在數據庫中。 hivekastenhq.com上的示例應用程序正在使用supabase Storage，但是任何其他類似的提供商（例如Cloudinary或Simple S3 Bucket）也可以完成這項工作。我之所以選擇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登錄和/或SUPABASE的Google/github用於對象存儲。

4. 啟動服務器！

// First time only
$ pnpm db:push

// dev
$ pnpm dev

// prod
$ pnpm build
$ pnpm start

？ Docker

您也可以與Docker一起自主主持人。為此，您必須：

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快捷方式，您可以創建一個“共享菜單”項目，該項目可以執行具有動態輸入的POST請求，即網頁的URL和標題。這使得從手機到Shipkasten的商品非常容易！文檔中的更多信息。

？瀏覽器擴展

工作中有一個伴隨瀏覽器擴展程序，您可以在瀏覽網絡時將其添加到保險庫中。它可以在ndom91/briefkasten-extension和CHROME擴展商店中找到。該存儲庫中的更多詳細信息。

？ ‍？屏幕截圖工作

還有一個背景工作可以填寫沒有有效圖像的書籤。它可以在ndom91/briefkasten-scrape存儲庫中找到。這項工作每2個小時在GitHub動作中運行一次，並一次處理10個書籤。

？貢獻

該項目對所有貢獻都開放！請堅持使用Eslint /更漂亮的設置，我很樂意看看您的問題 / PR？

執照

麻省理工學院