Papermark is the open-source DocSend alternative and secure data rooms with built-in analytics and custom domains.
docs: update README.md (#22)
Marc Seitza7629c96bd26
diff --git a/.env.example b/.env.exampleindex 84ae7606..209d07e6 100644--- a/.env.example+++ b/.env.example@@ -12,3 +12,6 @@ GOOGLE_CLIENT_ID=GOOGLE_CLIENT_SECRET=NEXT_PUBLIC_BASE_URL=http://localhost:3000++# This variable is from Resend to send emails+RESEND_API_KEY=\ No newline at end of filediff --git a/.github/CODEOWNERS b/.github/CODEOWNERSnew file mode 100644index 00000000..28777e84--- /dev/null+++ b/.github/CODEOWNERS@@ -0,0 +1,8 @@+# Learn how to add code owners here:+# https://help.github.com/en/articles/about-code-owners++# These owners will be the default owners for everything in the repo.+# Order is important; the last matching pattern takes the most precedence.++* @mfts+/.github/ @mfts\ No newline at end of filediff --git a/.github/images/papermark-welcome.gif b/.github/images/papermark-welcome.gifnew file mode 100644index 00000000..a289270eBinary files /dev/null and b/.github/images/papermark-welcome.gif differdiff --git a/README.md b/README.mdindex 4531db6b..4cce5446 100644--- a/README.md+++ b/README.md@@ -1,26 +1,36 @@<div align="center">- <h1 align="center">Papermark</h1>- <h5>Open-source alternative to DocSend</h5>+ <h1 align="center">Papermark</h1>+ <h3>The open-source DocSend alternative.</h3></div><div align="center">- <a href="https://papermark.io">papermark.io</a>+ <a href="https://www.papermark.io">papermark.io</a></div>++<br/>++<div align="center">+ <a href="https://github.com/mfts/papermark/stargazers"><img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/mfts/papermark"></a>+ <a href="https://twitter.com/mfts0"><img alt="Twitter Follow" src="https://img.shields.io/twitter/follow/mfts0"></a>+ <a href="https://github.com/mfts/papermark/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/badge/license-AGPLv3-purple"></a>+</div>+<br/>Papermark is an open-source document sharing alternative to DocSend with built-in analytics. Built with [Vercel Storage](http://vercel.com/storage) and [Vercel Edge Functions](http://vercel.com/edge).-This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).+## Features-- **Shareable Links:** Share your document securely by sending a link-- **Analytics:** Get analytics via link view tracking and soon page-by-page analytics+- **Shareable Links:** Share your document securely by sending a custom link+- **Analytics:** Get insights via document tracking and soon page-by-page analytics- **Self-hosted, open-source:** Host it yourself and hack on it-<br/>-+## Demo++## Tech Stack@@ -31,8 +41,74 @@ This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next- [Vercel Blob](https://vercel.com/storage/blob) - blob storage- [Vercel Postgres](https://vercel.com/storage/postgres) - database- [NextAuth.js](https://next-auth.js.org/) – auth+- [Resend](https://resend.com) – email- [Vercel](https://vercel.com/) – hosting++## Getting Started++### Prerequisites++Here's what you need to be able to run Papermark:++- Node.js (version >= 18)+- PostgreSQL (I use [Vercel Postgres](https://vercel.com/storage/postgres))+- Blob storage (I use [Vercel Blob](https://vercel.com/storage/blob))+- [Google OAuth Client](https://console.cloud.google.com/apis/credentials) (for authentication)+- [Resend](https://resend.com) (for sending emails)++### 1. Clone the repository++```shell+git clone https://github.com/mfts/papermark.git+cd papermark+```++### 2. Install npm dependencies++```shell+npm install+```++### 3. Copy the environment variables to `.env`++```shell+cp .env.example .env+```++### 4. Configure the variables in `.env`++| Variable | Value |+|---|---|+| NEXTAUTH_SECRET | a random string |+| NEXTAUTH_URL | < Your base doamin or localhost:3000 > |+| POSTGRES_PRISMA_URL | < Vercel Postgres Pooling URL > |+| POSTGRES_URL_NON_POOLING | < Vercel Postgres Non-Pooling URL > |+| BLOB_READ_WRITE_TOKEN | < Vercel Blob Token > |+| GOOGLE_CLIENT_ID | < Google Client ID > |+| GOOGLE_CLIENT_SECRET | < Google Client Secret > |+| RESEND_API_KEY | < Resend API KEY > |+| NEXT_PUBLIC_BASE_URL | < Your base domain or localhost:3000 > |+++### 5. Initialize the database++```shell+npx prisma generate+npx prisma db push+```++### 6. Run the dev server++```shell+npm run dev+```++### 7. Open the app in your browser++Visit [http://localhost:3000](http://localhost:3000) in your browser.++## Deploy your ownAll you need is a Vercel account and access to Vercel Storage (_Blob_ and _Postgres_). Click the@@ -44,6 +120,15 @@ button below to clone and deploy: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 ✨++<a href="https://github.com/mfts/papermark/graphs/contributors">+ <img src="https://contrib.rocks/image?repo=mfts/papermark" />+</a>++## Inspiration...and friends