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是一个开源项目，我们欢迎社区的捐款。

如果您想做出贡献，请分配存储库，并进行您想要的任何更改。拉力请求非常欢迎。

我们的贡献者