papermark

Papermark

開源文檔替代方案。

Papermark.io

PaperMark是Docsend的開源文檔共享替代方案，具有內置分析和自定義域。

特徵

• 可共享鏈接：通過發送自定義鏈接安全地共享您的文檔。
• 自定義品牌：添加自定義域名和您自己的品牌。
• 分析：通過文檔跟踪和逐頁分析獲得見解。
• 自託管，開源：自己託管並根據需要自定義。

演示

技術堆棧

• next.js - 框架
• 打字稿 - 語言
• 尾風 - CSS
• shadcn/ui -UI組件
• Prisma- Orm
• PostgreSQL-數據庫
• NextAuth.js - 身份驗證
• Tinybird - 分析
• 重新發送 - 電子郵件
• 條紋 - 付款
• Vercel - 託管

入門

先決條件

這是您需要運行Papermark的內容：

• node.js（版本> = 18.17.0）
• PostgreSQL數據庫
• BLOB存儲（當前AWS S3或Vercel Blob）
• 重新發出（用於發送電子郵件）

1。克隆存儲庫

git clone https://github.com/mfts/papermark.git
cd papermark

2。安裝NPM依賴項

npm install

3。將環境變量複製為.env並更改值

cp .env.example .env

4。初始化數據庫

npm run dev:prisma

5。運行開發服務器

npm run dev

6。在瀏覽器中打開應用程序

訪問http：// localhost：3000在您的瀏覽器中。

小鳥說明

要準備Tinybird數據庫，請按照以下步驟：

0. 我們使用pipenv來管理我們的python依賴性。如果未安裝它，則可以使用以下命令安裝它：

   pkgx pipenv

1. 從此處下載Tinybird CLI並將其安裝在系統上。
2. 使用Tinybird CLI進行身份驗證後，導航到lib/tinybird目錄：

    cd lib/tinybird

3. 使用以下命令推動必要的數據源：

   tb push datasources/ *
   tb push endpoints/get_ *

4. 不要忘記將.env文件中的適當權利設置為TINYBIRD_TOKEN 。

更新tinybird

pipenv shell
# # start: pkgx-specific
cd ..
cd papermark
# # end: pkgx-specific
pipenv update tinybird-cli

貢獻

Papermark是一個開源項目，我們歡迎社區的捐款。

如果您想做出貢獻，請分配存儲​​庫，並進行您想要的任何更改。拉力請求非常歡迎。

我們的貢獻者