papermark

Papermark

Die Open-Source Docsend-Alternative.

Papermark.io

Papermark ist die Open-Source-Dokumenten-Alternative zu Docsend mit integrierten Analysen und benutzerdefinierten Domänen.

Merkmale

• Freigabes Links: Teilen Sie Ihre Dokumente sicher, indem Sie einen benutzerdefinierten Link senden.
• Custom Branding: Fügen Sie eine benutzerdefinierte Domain und Ihr eigenes Branding hinzu.
• Analytics: Gewinnen Sie Erkenntnisse durch Dokumentverfolgung und bald Seite für Seite Analytics.
• Selbst gehostete, Open-Source: hosten Sie es selbst und passen Sie es nach Bedarf an.

Demo

Tech Stack

• Weiter.js - Framework
• TypeScript - Sprache
• Rückenwind - CSS
• Shadcn/UI - UI -Komponenten
• Prisma - Orm
• PostgreSQL - Datenbank
• NextAuth.js - Authentifizierung
• Tinybird - Analytics
• Wiederverenden - E -Mail
• Streifen - Zahlungen
• Vercel - Hosting

Erste Schritte

Voraussetzungen

Hier ist, was Sie zum Ausführen von Papermark benötigen:

• Node.js (Version> = 18.17.0)
• PostgreSQL -Datenbank
• BLOB -Speicher (derzeit AWS S3 oder Vercel Blob)
• Senden Sie erneut (zum Senden von E -Mails)

1. Klonen Sie das Repository klonen

git clone https://github.com/mfts/papermark.git
cd papermark

2. Installieren Sie NPM -Abhängigkeiten

npm install

3. Kopieren Sie die Umgebungsvariablen in .env und ändern Sie die Werte

cp .env.example .env

4. Initialisieren Sie die Datenbank

npm run dev:prisma

5. Führen Sie den Dev -Server aus

npm run dev

6. Öffnen Sie die App in Ihrem Browser

Besuchen Sie http: // localhost: 3000 in Ihrem Browser.

Tinybird -Anweisungen

Befolgen Sie die folgenden Schritte, um die Tinybird -Datenbank vorzubereiten:

0. Wir verwenden pipenv , um unsere Python -Abhängigkeiten zu verwalten. Wenn Sie es nicht installieren lassen, können Sie es mit dem folgenden Befehl installieren:

   pkgx pipenv

1. Laden Sie hier die Tinybird CLI herunter und installieren Sie sie auf Ihrem System.
2. Navigieren Sie nach der Authentifizierung mit der Tinybird CLI zum lib/tinybird -Verzeichnis:

    cd lib/tinybird

3. Drücken Sie die erforderlichen Datenquellen mit dem folgenden Befehl:

   tb push datasources/ *
   tb push endpoints/get_ *

4. Vergessen Sie nicht, den TINYBIRD_TOKEN mit den entsprechenden Rechten in Ihrer .env -Datei festzulegen.

Tinybird aktualisieren

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

Beitragen

Papermark ist ein Open-Source-Projekt, und wir begrüßen Beiträge der Community.

Wenn Sie einen Beitrag leisten möchten, geben Sie bitte das Repository aus und nehmen Sie Änderungen vor, die Sie möchten. Zuganfragen sind herzlich willkommen.

Unsere Mitwirkenden