papermark

Papel de papel

La alternativa de documentos de código abierto.

Papermark.io

Papermark es la alternativa de intercambio de documentos de código abierto a Docsend, con análisis incorporados y dominios personalizados.

Características

• Enlaces compartibles: comparta sus documentos de forma segura enviando un enlace personalizado.
• Marca personalizada: agregue un dominio personalizado y su propia marca.
• Análisis: obtenga información a través del seguimiento de documentos y pronto análisis de página por página.
• Holteado, de código abierto: alojarlo usted mismo y personalizarlo según sea necesario.

Manifestación

Pila de tecnología

• Next.js - Marco
• TypeScript - Lenguaje
• Viento de cola - CSS
• Shadcn/UI - Componentes de UI
• Prisma - orm
• PostgreSQL - Base de datos
• NextAuth.js - Autenticación
• TinyBird - Análisis
• Reenvío - Correo electrónico
• Stripe - Pagos
• VERCEL - Hosting

Empezando

Requisitos previos

Esto es lo que necesitas para ejecutar Papermark:

• Node.js (versión> = 18.17.0)
• Base de datos PostgreSQL
• Almacenamiento de blob (actualmente AWS S3 o Vercel Blob)
• Reenviar (para enviar correos electrónicos)

1. Clonar el repositorio

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

2. Instalar dependencias de NPM

npm install

3. Copie las variables de entorno a .env y cambie los valores

cp .env.example .env

4. Inicializar la base de datos

npm run dev:prisma

5. Ejecute el servidor Dev

npm run dev

6. Abra la aplicación en su navegador

Visite http: // localhost: 3000 en su navegador.

Instrucciones de tinybird

Para preparar la base de datos TinyBird, siga estos pasos:

0. Utilizamos pipenv para administrar nuestras dependencias de Python. Si no lo tiene instalado, puede instalarlo utilizando el siguiente comando:

   pkgx pipenv

1. Descargue el TinyBird CLI desde aquí e instálelo en su sistema.
2. Después de autenticarse con el TinyBird CLI, navegue hasta el directorio lib/tinybird :

    cd lib/tinybird

3. Presione las fuentes de datos necesarias utilizando el siguiente comando:

   tb push datasources/ *
   tb push endpoints/get_ *

4. No olvide establecer el TINYBIRD_TOKEN con los derechos apropiados en su archivo .env .

Actualización de TinyBird

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

Que contribuye

Papermark es un proyecto de código abierto, y damos la bienvenida a las contribuciones de la comunidad.

Si desea contribuir, desembolse el repositorio y realice cualquier cambio que desee. Las solicitudes de extracción son cálidamente bienvenidas.

Nuestros contribuyentes