Papermark is an open-source document sharing alternative to DocSend with built-in analytics. Built with Vercel Storage and Vercel Edge Functions.
- Shareable Links: Share your document securely by sending a custom link
- Analytics: Get insights via document tracking and soon page-by-page analytics
- Self-hosted, open-source: Host it yourself and hack on it
- Next.js – framework
- Typescript – language
- Tailwind – styling
- Prisma - orm
- Vercel Blob - blob storage
- Vercel Postgres - database
- NextAuth.js – auth
- Resend – email
- Vercel – hosting
Here's what you need to be able to run Papermark:
- Node.js (version >= 18)
- PostgreSQL (I use Vercel Postgres)
- Blob storage (I use Vercel Blob)
- Google OAuth Client (for authentication)
- Resend (for sending emails)
git clone https://github.com/mfts/papermark.git
cd papermarknpm installcp .env.example .env| Variable | Value |
|---|---|
| NEXTAUTH_SECRET | a random string |
| NEXTAUTH_URL | < Your base domain or localhost:3000 > |
| POSTGRES_PRISMA_URL | < Vercel Postgres Pooling URL > |
| POSTGRES_URL_NON_POOLING | < Vercel Postgres Non-Pooling URL > |
| BLOB_READ_WRITE_TOKEN | < Vercel Blob Token > |
| GOOGLE_CLIENT_ID | < Google Client ID > |
| GOOGLE_CLIENT_SECRET | < Google Client Secret > |
| RESEND_API_KEY | < Resend API KEY > |
| NEXT_PUBLIC_BASE_URL | < Your base domain or localhost:3000 > |
npx prisma generate
npx prisma db pushnpm run devVisit http://localhost:3000 in your browser.
To prepare the Tinybird database, follow these steps:
- We use
pipenvto manage my Python dependencies. If you don't have it installed, you can install it using the following command:pkgx pipenv
- Download the Tinybird CLI from here and install it on your system.
- After authenticating with the Tinybird CLI, navigate to the
lib/tinybirddirectory:cd lib/tinybird - Push the necessary datasources using the following command:
tb push datasources/* tb push endpoints/get_*
- Don't forget to set the
TINYBIRD_TOKENwith the appropriate rights in your.envfile.
pipenv shell
## start: pkgx-specific
cd ..
cd papermark
## end: pkgx-specific
pipenv update tinybird-cliAll you need is a Vercel account and access to Vercel Storage (Blob and Postgres). Click the button below to clone and deploy:
Papermark is an open-source project and we welcome contributions from the community.
If you'd like to contribute, please fork the repository and make changes as you'd like. Pull requests are warmly welcome.