papermark

Papermarde

L'alternative Docsend open-source.

papermark.io

Papermark est l'alternative de partage de documents open source à Docsend, avec des analyses intégrées et des domaines personnalisés.

Caractéristiques

• Liens partageables: partagez vos documents en toute sécurité en envoyant un lien personnalisé.
• Branding personnalisé: ajoutez un domaine personnalisé et votre propre marque.
• Analytique: acquérir des informations grâce au suivi des documents et à l'analyse bientôt par page.
• Auto-hébergé, open-source: hébergez-le vous-même et personnalisez-le au besoin.

Démo

Pile technologique

• Next.js - Framework
• TypeScript - Langue
• Vent arrière - CSS
• shadcn / ui - composants UI
• Prisma - orm
• PostgreSQL - base de données
• NextAuth.js - Authentification
• Tinybird - Analytics
• RENNI - EMAIL
• Stripe - Paiements
• Vercel - Hébergement

Commencer

Condition préalable

Voici ce dont vous avez besoin pour gérer Papermark:

• Node.js (version> = 18.17.0)
• Base de données PostgreSQL
• Blob Storage (actuellement AWS S3 ou Vercel Blob)
• Renvoi (pour envoyer des e-mails)

1. Clone le référentiel

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

2. Installez les dépendances NPM

npm install

3. Copiez les variables d'environnement sur .env et modifiez les valeurs

cp .env.example .env

4. Initialisez la base de données

npm run dev:prisma

5. Exécutez le serveur de développement

npm run dev

6. Ouvrez l'application dans votre navigateur

Visitez http: // localhost: 3000 dans votre navigateur.

Instructions Tinybird

Pour préparer la base de données Tinybird, suivez ces étapes:

0. Nous utilisons pipenv pour gérer nos dépendances Python. Si vous ne l'avez pas installé, vous pouvez l'installer en utilisant la commande suivante:

   pkgx pipenv

1. Téléchargez la CLI Tinybird à partir d'ici et installez-la sur votre système.
2. Après s'authentifier avec la CLI Tinybird, accédez au répertoire lib/tinybird :

    cd lib/tinybird

3. Poussez les sources de données nécessaires à l'aide de la commande suivante:

   tb push datasources/ *
   tb push endpoints/get_ *

4. N'oubliez pas de définir le TINYBIRD_TOKEN avec les droits appropriés dans votre fichier .env .

Mise à jour de Tinybird

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

Contributif

Papermark est un projet open-source et nous accueillons les contributions de la communauté.

Si vous souhaitez contribuer, veuillez débarquer le référentiel et apporter toutes les modifications que vous souhaitez. Les demandes de traction sont chaleureusement les bienvenues.

Nos contributeurs