papermark

Papermark

ทางเลือกเอกสารโอเพนซอร์ซ

papermark.io

Papermark เป็นทางเลือกการแบ่งปันเอกสารโอเพ่นซอร์สสำหรับ DocSend ซึ่งมีการวิเคราะห์ในตัวและโดเมนที่กำหนดเอง

คุณสมบัติ

• ลิงก์ที่แชร์ได้: แบ่งปันเอกสารของคุณอย่างปลอดภัยโดยส่งลิงค์ที่กำหนดเอง
• การสร้างแบรนด์ที่กำหนดเอง: เพิ่มโดเมนที่กำหนดเองและการสร้างแบรนด์ของคุณเอง
• Analytics: รับข้อมูลเชิงลึกผ่านการติดตามเอกสารและการวิเคราะห์แบบหน้าหน้าในไม่ช้า
• โฮสต์โอเพ่นซอร์ส: โฮสต์ด้วยตัวคุณเองและปรับแต่งตามต้องการ

การสาธิต

ซ้อนเทค

• next.js - เฟรมเวิร์ก
• TypeScript - ภาษา
• Tailwind - CSS
• Shadcn/UI - ส่วนประกอบ UI
• Prisma - orm
• PostgreSQL - ฐานข้อมูล
• nextauth.js - การรับรองความถูกต้อง
• Tinybird - Analytics
• ส่งกลับ - อีเมล
• Stripe - การชำระเงิน
• vercel - โฮสติ้ง

เริ่มต้น

ข้อกำหนดเบื้องต้น

นี่คือสิ่งที่คุณต้องการเรียกใช้ Papermark:

• node.js (เวอร์ชัน> = 18.17.0)
• ฐานข้อมูล PostgreSQL
• BLOB Storage (ปัจจุบัน 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. เรียกใช้เซิร์ฟเวอร์ dev

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. อย่าลืมตั้ง TINYBIRD_TOKEN ด้วยสิทธิ์ที่เหมาะสมในไฟล์ .env ของคุณ

อัปเดต Tinybird

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

การบริจาค

Papermark เป็นโครงการโอเพ่นซอร์สและเรายินดีต้อนรับการมีส่วนร่วมจากชุมชน

หากคุณต้องการมีส่วนร่วมโปรดแยกที่เก็บและทำการเปลี่ยนแปลงใด ๆ ที่คุณต้องการ คำขอดึงยินดีต้อนรับอย่างอบอุ่น

ผู้มีส่วนร่วมของเรา