papermark

Marcaça

A alternativa de código aberto docsend.

Papermark.io

Papermark é a alternativa de compartilhamento de documentos de código aberto ao Docsend, com análises e domínios personalizados integrados.

Características

• Links compartilháveis: compartilhe seus documentos com segurança enviando um link personalizado.
• Marca personalizada: adicione um domínio personalizado e sua própria marca.
• Analytics: Ganhe insights através de rastreamento de documentos e em breve análise de página a página.
• Auto-hospedado, código aberto: hospede-o e personalize-o conforme necessário.

Demonstração

Pilha de tecnologia

• NEXT.JS - Framework
• TypeScript - Idioma
• Tailwind - CSS
• shadcn/ui - componentes da interface do usuário
• Prisma - orm
• PostgreSQL - banco de dados
• NextAuth.js - Autenticação
• TinyBird - Analytics
• RENESENÇÃO - E -mail
• Stripe - Pagamentos
• Vercel - hospedagem

Começando

Pré -requisitos

Aqui está o que você precisa para executar papermark:

• Node.js (versão> = 18.17.0)
• Banco de dados PostgreSQL
• Blob Storage (atualmente AWS S3 ou Vercel Blob)
• Reenvie (para enviar e -mails)

1. Clone o repositório

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

2. Instale as dependências da NPM

npm install

3. Copie as variáveis ​​do ambiente para .env e altere os valores

cp .env.example .env

4. Inicialize o banco de dados

npm run dev:prisma

5. Execute o servidor de desenvolvimento

npm run dev

6. Abra o aplicativo em seu navegador

Visite http: // localhost: 3000 no seu navegador.

Instruções de Tinybird

Para preparar o banco de dados Tinybird, siga estas etapas:

0. Usamos pipenv para gerenciar nossas dependências do Python. Se você não o tiver instalado, pode instalá -lo usando o seguinte comando:

   pkgx pipenv

1. Faça o download da CLI da Tinybird aqui e instale -a no seu sistema.
2. Depois de se autenticar com a CLI da Tinybird, navegue até o diretório lib/tinybird :

    cd lib/tinybird

3. Empurre as fontes de dados necessárias usando o seguinte comando:

   tb push datasources/ *
   tb push endpoints/get_ *

4. Não se esqueça de definir o TINYBIRD_TOKEN com os direitos apropriados no seu arquivo .env .

Atualizando Tinybird

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

Contribuindo

O Papermark é um projeto de código aberto e agradecemos contribuições da comunidade.

Se você quiser contribuir, bifurque o repositório e faça as alterações que desejar. Os pedidos de tração são calorosamente bem -vindos.

Nossos colaboradores