mfts/papermark
Fork: 652 Star: 4758 (更新于 2024-10-15 19:25:38)
license: AGPL-3.0
Language: TypeScript .
Papermark is the open-source DocSend alternative with built-in analytics and custom domains.
最后发布版本: v0.16.0 ( 2024-09-18 21:03:18)
Papermark is the open-source document sharing alternative to DocSend with built-in analytics and custom domains.
Features
- Shareable Links: Share your document securely by sending a custom link
- Custom Branding: Add a custom domain and your own branding
- Analytics: Get insights via document tracking and soon page-by-page analytics
- Self-hosted, open-source: Host it yourself and hack on it
Demo
Tech Stack
- Next.js – Framework
- Typescript – Language
- Tailwind – CSS
- shadcn/ui - UI Components
- Prisma - ORM
- PostgreSQL - Database
- NextAuth.js – Authentication
- Tinybird – Analytics
- Resend – Email
- Stripe – Payments
- Vercel – Hosting
Getting Started
Prerequisites
Here's what you need to be able to run Papermark:
- Node.js (version >= 18.17.0)
- PostgreSQL Database
- Blob storage (currently AWS S3 or Vercel Blob)
- Resend (for sending emails)
1. Clone the repository
git clone https://github.com/mfts/papermark.git
cd papermark
2. Install npm dependencies
npm install
3. Copy the environment variables to .env
and change the values
cp .env.example .env
4. Initialize the database
npm run dev:prisma
5. Run the dev server
npm run dev
6. Open the app in your browser
Visit http://localhost:3000 in your browser.
Tinybird instructions
To prepare the Tinybird database, follow these steps:
- We use
pipenv
to 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/tinybird
directory: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_TOKEN
with the appropriate rights in your.env
file.
Updating Tinybird
pipenv shell
## start: pkgx-specific
cd ..
cd papermark
## end: pkgx-specific
pipenv update tinybird-cli
Contributing
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.
Our Contributors ✨
最近版本更新:(数据更新于 2024-10-15 04:20:09)
2024-09-18 21:03:18 v0.16.0
2024-08-28 19:55:14 v0.15.0
2024-06-06 17:42:47 v0.13.0
2024-04-29 22:06:58 v0.12.0
2024-03-18 11:08:11 v0.11.0
2024-02-21 18:30:11 v0.10.0
2024-02-01 17:10:59 v0.9.0
主题(topics):
dataroom, hacktoberfest, next-auth, nextjs, open-source, pdf, postgresql, prisma, tailwindcss, typescript, zod
mfts/papermark同语言 TypeScript最近更新仓库
2024-10-15 21:20:39 CopilotKit/CopilotKit
2024-10-15 21:12:34 LLOneBot/LLOneBot
2024-10-15 19:04:52 immich-app/immich
2024-10-15 16:08:09 langgenius/dify
2024-10-15 14:18:35 continuedev/continue
2024-10-15 11:41:40 siyuan-note/siyuan