这个 5k star 的开源项目,让你也拥有自己的文档协作网站


大家好,我是热爱开源的了不起。

日常的工作中,文档的云协作是必不可少的一环。如果是公司内部的协作,一般都用自研的文档协作或者是飞书文档来实现。不过如果和公司外部的合作方来进行文档协作,应该怎么办呢?今天了不起为大家介绍一个开源的文档协作项目——papermark。

项目简介

Papermark 是一个开源的文档共享平台,它提供了类似于 DocSend 的服务,但完全是免费的,并且用户可以自行托管。 Papermark 的主要特点包括:

  1. 可分享链接:用户可以创建一个定制的链接来安全地分享文档。
  2. 自定义域名:用户可以添加自己的域名,使得文档分享更加个性化。
  3. 内置分析:Papermark 能够追踪文档的访问情况,未来还将支持逐页分析功能。
  4. 开源和自托管:作为开源项目,用户可以自由地下载、修改和运行 Papermark,完全控制自己的数据。

Papermark 使用的技术栈包括 Next.js 框架、Typescript 语言、Tailwind CSS 样式、shadcn/ui UI 组件、Prisma ORM、PostgreSQL 数据库等。

项目安装

项目主页给出了比较详细的安装过程,按部就班的执行就可以啦:

1
2
3
4
5
6
7
8
9
10
11
-- 下载源码
git clone https://github.com/mfts/papermark.git
cd papermark
-- 安装npm依赖
npm install
-- 将环境变量复制到.env并更改值
cp .env.example .env
-- 初始化数据库
npm run dev:prisma
-- 运行
npm run dev

项目使用

安装启动完成后,在浏览器中访问 http://localhost:3000 就可以进入首页了,如图:

点击“get started”按钮后,就可以将文档拖拽到 papermark 中进行上传。

上传完成后,可以直接生成一个分享链接,这样就可以把你的文档分享给其他人了。

总结

Papermark 适合多种使用场景,包括企业文档分享、个人文档管理以及开发者工具。企业可以使用 Papermark 来安全地与客户或合作伙伴分享重要文档,同时保持品牌一致性。个人用户可以利用 Papermark 来管理和分享个人文档,如简历、作品集等。开发者可以部署 Papermark 作为自己的文档分享平台,或者作为学习开源项目和现代 Web 开发技术的工具。感兴趣的朋友们赶快去试试吧 ~

1
项目地址:https://github.com/mfts/papermark

  目录