dataroom

README

Hanzo Dataroom

The open-source DocSend alternative.

dataroom.hanzo.ai

Hanzo Dataroom is the open-source document-sharing alternative to DocSend, featuring built-in analytics and custom domains.

Features

• Shareable Links: Share your documents securely by sending a custom link.
• Custom Branding: Add a custom domain and your own branding.
• Analytics: Gain insights through document tracking and soon page-by-page analytics.
• Self-hosted, Open-source: Host it yourself and customize it as needed.

Demo

Tech Stack

• Next.js – Framework
• TypeScript – Language
• Tailwind – CSS
• shadcn/ui - UI Components
• Prisma - ORM
• PostgreSQL - Database
• NextAuth.js – Authentication
• Tinybird – Analytics
• Resend – Email
• Stripe – Payments
• Vercel – Hosting

Getting Started

Prerequisites

Here's what you need to run Hanzo Dataroom:

• Node.js (version >= 18.17.0)
• PostgreSQL Database
• Blob storage (currently AWS S3 or Vercel Blob)
• Resend (for sending emails)

1. Clone the repository

git clone https://github.com/hanzoai/dataroom.git
cd hanzo-dataroom

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

npm run dev:prisma

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 our 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 data sources 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 hanzo-dataroom
## end: pkgx-specific
pipenv update tinybird-cli

Contributing

Hanzo Dataroom is an open-source project, and we welcome contributions from the community.

If you'd like to contribute, please fork the repository and make any changes you'd like. Pull requests are warmly welcome.

Our Contributors ✨

Documentation

Overview

Package dataroom embeds the Hanzo Dataroom goja bundle so the unified hanzoai/cloud binary can serve /v1/dataroom/* in-process via the dop251/goja engine, without a Next.js runtime or Prisma/Postgres (HIP-0106, task #101).

The TypeScript/Next.js app remains the primary artifact and reference for the domain. This Go file is a read-only embed:

• Bundle() returns goja/bundle.js — the self-contained, ESM-free port of the dataroom surface (documents, data rooms, shareable links with access controls, viewers, per-page view analytics) exposing globalThis.handle(req).

The bundle carries LOGIC only. Its host capabilities — a per-tenant Base/SQLite store (globalThis.__db), the bcrypt primitive link passwords are hashed with (globalThis.__bcrypt), and the object storage the document bytes live in — are injected by the Go host in github.com/hanzoai/cloud/apps/dataroom. See goja/README.md for the contract.

Index

• func Bundle() ([]byte, error)

Functions

func Bundle

func Bundle() ([]byte, error)

Bundle returns the goja bundle source (goja/bundle.js). The host compiles this once and runs it on each pooled goja runtime.