Giter Club home page Giter Club logo

papermark's Introduction

Papermark

The open-source DocSend alternative.

Papermark - The open-source DocSend alternative | Product Hunt


GitHub Repo stars Twitter Follow License

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

Papermark Welcome GIF

Tech Stack

Getting Started

Prerequisites

Here's what you need to be able to run Papermark:

  • Node.js (version >= 18)
  • 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

npx prisma generate
npx prisma migrate deploy

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:

  1. 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
  2. Download the Tinybird CLI from here and install it on your system.
  3. After authenticating with the Tinybird CLI, navigate to the lib/tinybird directory:
    cd lib/tinybird
  4. Push the necessary datasources using the following command:
    tb push datasources/*
    tb push endpoints/get_*
  5. 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 ✨

papermark's People

Contributors

mfts avatar aashish-upadhyay-101 avatar shnai0 avatar ashrafchowdury avatar vndpal avatar digant2482 avatar jeet1desai avatar rockingthor avatar ephraimduncan avatar rudraksh88 avatar sachin-duhan avatar tedspare avatar tsikatawill avatar sammitbadodekar avatar addegbenga avatar bilalqv avatar hunnysajid avatar shree7676 avatar yashsharma999 avatar hanadi92 avatar tanayvaswani avatar tarunmeena6846 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.