papermark

Papermark

オープンソースDocsendの代替。

Papermark.io

Papermarkは、組み込みの分析とカスタムドメインを備えたDocsendに代わるオープンソースのドキュメント共有の代替品です。

特徴

• 共有リンク：カスタムリンクを送信して、ドキュメントを安全に共有します。
• カスタムブランディング：カスタムドメインと独自のブランディングを追加します。
• 分析：ドキュメントトラッキングと間もなくページごとの分析を通じて洞察を得ます。
• 自己ホスト、オープンソース：自分でホストし、必要に応じてカスタマイズします。

デモ

技術スタック

• next.js - フレームワーク
• タイプスクリプト - 言語
• Tailwind - CSS
• SHADCN/UI -UIコンポーネント
• プリスマ - orm
• postgreSQL -データベース
• nextauth.js - 認証
• Tinybird - 分析
• 再送信 - 電子メール
• ストライプ - 支払い
• Vercel - ホスティング

はじめる

前提条件

これがPapermarkを実行するために必要なものです：

• node.js（バージョン> = 18.17.0）
• PostgreSQLデータベース
• ブロブストレージ（現在AWS S3またはVercelBlob）
• 再送信（電子メールの送信用）

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.開発サーバーを実行します

npm run dev

6.ブラウザでアプリを開きます

ブラウザのhttp：// localhost：3000にアクセスしてください。

Tinybirdの指示

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. .envファイルに適切な権利を備えたTINYBIRD_TOKENを設定することを忘れないでください。

Tinybirdの更新

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

貢献

Papermarkはオープンソースプロジェクトであり、コミュニティからの貢献を歓迎します。

貢献したい場合は、リポジトリをフォークして変更をお願いします。プルリクエストは温かく大歓迎です。

私たちの貢献者